Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add examples to docstrings #7937

Merged
merged 36 commits into from
Jul 25, 2023
Merged

Conversation

harshitha1201
Copy link
Contributor

@harshitha1201 harshitha1201 commented Jun 23, 2023

Added docstring examples to some string methods (#6793)

[ ] Closes #xxxx
[ ] Tests added
[ ] User visible changes (including notable bug fixes) are documented in whats-new.rst
[ ] New functions/methods are listed in api.rst

Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

These 3 docstrings should really have examples that highlight what the difference between the behaviour of .equals, .broadcast_equals, and .identical is. We should talk about this together on the next call.

xarray/core/dataset.py Outdated Show resolved Hide resolved
@harshitha1201 harshitha1201 requested a review from TomNicholas July 7, 2023 13:58
@TomNicholas
Copy link
Member

Can you make an issue pointing to the failing CI tests here please?

Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Add what's new!

xarray/core/dataset.py Show resolved Hide resolved
xarray/core/dataset.py Show resolved Hide resolved
xarray/core/dataset.py Show resolved Hide resolved
xarray/core/dataset.py Show resolved Hide resolved
xarray/core/dataset.py Show resolved Hide resolved
xarray/core/dataset.py Outdated Show resolved Hide resolved
xarray/core/dataset.py Outdated Show resolved Hide resolved
@TomNicholas TomNicholas enabled auto-merge (squash) July 19, 2023 16:29
@TomNicholas TomNicholas merged commit bb501ba into pydata:main Jul 25, 2023
@harshitha1201 harshitha1201 deleted the add-examples3 branch July 25, 2023 06:07
@dcherian
Copy link
Contributor

Thanks
@harshitha1201. This is great work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants