Repository navigation
Docstrings: Google sections and cross-references; licence headers on every file - #381
Merged
Merged
Conversation
This file contains hidden or 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
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.
Every Python file we wrote now starts with the three licence lines, and every docstring that used Sphinx roles or fields now uses Google sections and single-backtick cross-references.
:class:~pkg.Foois nowFoo <pkg.Foo>``, and:param:and `:return:` became `Args` and `Returns` sections with the same words.Only comments and docstrings changed, in two commits: one for the docstrings, one for the headers. For every changed file, the code parses to an identical syntax tree before and after, with docstrings and comments stripped, and no changed docstring is read back as
__doc__. The flake8 lint is clean on the changed files.Left alone: the vendored test corpus under
tests/vendor/, andtests/support/ulab/numpy.py, which says it is ported from ulab.