Docformatter hooks and docstring standardisation #187
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Note: had to use --no-verify option to commit because docformatter has touched most if not all modules in cf/ and there are F841 and F821 cases which are yet to be addressed for flake8 error codes.
|
Cancelling the CI workflows because they will fail for the same reason as #186 (comment). I'll get the |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to NCAS-CMS/cfunits#22, but only to auto-format to, and set up a pre-commit hook for,
docformatter, i.e. without (additionally) the formatting to abide by check pre-commit forpydocstylecompliance to Google-style docstrings.Adapting the codebase to abide by
pydocstylewill be postponed for cf-python because it is a manual process that would have to be done manually (and very likely incrementally), and we want to get started right away on the Dask-migration related work (#182) which requires a separate branch (dask) to keep in sync.