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

Bring alias docstrings more in line with style guide. #406

Closed
wants to merge 0 commits into from

Conversation

copybara-service[bot]
Copy link

Bring alias docstrings more in line with style guide.

This includes four types of changes:

  • Capitalization of the first letter (previously this was inconsistent with
    lower case first letter being used more often). Now they all use capital
    letters like in the style guide.
  • American spelling as required by the style guide.
  • Remove type information from Args section in the docstring wherever this
    information is already provided by the type annotation.
  • Remove default values from the Args section in the docstring if this
    information is already provided in the function signature.

The last two items are to avoid duplicate information, which runs the risk of
becoming wrong or inconsistent over time.

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.

None yet

0 participants