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

data batch docstring re-formatting: 'Examples:' -> 'Examples' #381

Conversation

sadielbartholomew
Copy link
Member

@sadielbartholomew sadielbartholomew commented Apr 12, 2022

Re-apply #362 (see details there), which we reverted because the merge, at the time, caused some unanticipated merge conflicts that it was simplest to avoid. After #356 has been merged, which should be imminent, will be a convenient time to make this update. (Then there will be no need to update the docstrings manually in this respect.)

Note: do not merge until #356 has been merged, since that is a large PR in terms of line changes and code movement (any conflicts emerging on other open Dask migration PRs due to this, if any, will be minor, so they don't need to by considered). (see comment below RE this)

@sadielbartholomew sadielbartholomew added documentation Improvements or additions to documentation code tidy labels Apr 12, 2022
@sadielbartholomew sadielbartholomew self-assigned this Apr 12, 2022
@sadielbartholomew sadielbartholomew force-pushed the dask-examples-docstring-format branch from 43362f6 to 5b7f8b3 Compare April 20, 2022 18:53
@sadielbartholomew
Copy link
Member Author

sadielbartholomew commented Apr 20, 2022

In the end I have re-applied the sed batch replacement on the lama-to-dask branch as updated to the present state, since that was easier than resolving the corresponding merge conflicts. I have double-checked that the line count of the changes is the same as the number of Example: cases that were under data/ (now reduced to none) and that the tests still pass, to ensure I am not touching anything I shouldn't be for this scope. Good to merge now.

@sadielbartholomew sadielbartholomew merged commit 402245d into NCAS-CMS:lama-to-dask Apr 20, 2022
@sadielbartholomew sadielbartholomew deleted the dask-examples-docstring-format branch April 20, 2022 19:01
@davidhassell
Copy link
Collaborator

Great!

@davidhassell davidhassell added this to the 3.13.0 milestone Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code tidy documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants