Skip to content

Rename SGrid2DMetadata/SGrid3DMetadata __str__ to describe() - #2938

Merged
VeckoTheGecko merged 4 commits into
Parcels-code:mainfrom
VeckoTheGecko:push-qwkxqnxvqllx
Oct 6, 2026
Merged

VeckoTheGecko merged 4 commits into
Parcels-code:mainfrom
VeckoTheGecko:push-qwkxqnxvqllx

Conversation

@VeckoTheGecko

Copy link
Copy Markdown
Contributor

Description

This is more accurate as to what the purpose of the code is, and lines up better with the rest of the codebase.

Checklist

  • Closes None
  • Tests added
  • This PR targets the correct branch (main for normal development, v3-support for v3 support)

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested any AI-generated content in my PR.
    • I take responsibility for any AI-generated content in my PR.
    • Describe how you used it (e.g., by pasting your prompt): Small refactoring

Follow the same pattern as FieldSet.describe: accept an optional
writable buffer and fall back to sys.stdout.
@VeckoTheGecko

Copy link
Copy Markdown
Contributor Author

I've also updated the functionality to match the rest of the .describe() functions (i.e., write to a buffer, so that it prints it to screen automatically)

@VeckoTheGecko
VeckoTheGecko merged commit 6e1a810 into Parcels-code:main Oct 6, 2026
19 of 21 checks passed
@VeckoTheGecko
VeckoTheGecko deleted the push-qwkxqnxvqllx branch October 6, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant