Skip to content

FEAT: Update FieldSet.describe() to print output and update docs#2738

Merged
VeckoTheGecko merged 5 commits into
Parcels-code:mainfrom
VeckoTheGecko:push-vorntontyusn
Jul 9, 2026
Merged

FEAT: Update FieldSet.describe() to print output and update docs#2738
VeckoTheGecko merged 5 commits into
Parcels-code:mainfrom
VeckoTheGecko:push-vorntontyusn

Conversation

@VeckoTheGecko

Copy link
Copy Markdown
Contributor

Description

Turns out that Jupyter notebooks format the output of __repr__'s differently from other functions (really, I should have expected that).

This PR updates the describe function to print to terminal by default instead (this implementation is the same as what xr.Dataset.info() does.

Checklist

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

AI Disclosure

None used

@erikvansebille erikvansebille left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, implemented these also in the notebooks. Happy to be merged!

@VeckoTheGecko VeckoTheGecko changed the title FEAT: Update FieldSet.describe() to print output FEAT: Update FieldSet.describe() to print output and update docs Jul 9, 2026
@VeckoTheGecko VeckoTheGecko merged commit 05d1e16 into Parcels-code:main Jul 9, 2026
17 checks passed
@VeckoTheGecko VeckoTheGecko deleted the push-vorntontyusn branch July 9, 2026 08:16
@github-project-automation github-project-automation Bot moved this from Backlog to Done in Parcels development Jul 9, 2026
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.

2 participants