Skip to content

[*.py] Rename "Arguments:" to "Args:" #456

New issue

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

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

Already on GitHub? # to your account

Conversation

SamuelMarks
Copy link

@SamuelMarks SamuelMarks commented Dec 5, 2020

EDIT: Most of these changes are to the Keras format, not the Google one. Only consider merging this PR [as is] iff keras-team/keras-contrib#550 is accepted

I've written custom parsers and emitters for everything from docstrings to classes and functions. However, I recently came across an issue with the TensorFlow codebase: inconsistent use of Args: and Arguments: in its docstrings. It is easy enough to extend my parsers to support both variants, however it looks like Arguments: is wrong anyway, as per:

Therefore, only Args: is valid. This PR replaces them throughout the codebase.

PS: For related PRs, see tensorflow/tensorflow/pull/45420

@haifeng-jin
Copy link
Collaborator

We actually use the style of # Arguments instead of # Arguments:.
So I am closing this issue.

@SamuelMarks
Copy link
Author

@haifeng-jin In that case shall I close keras-team/keras-contrib/pull/550?

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

Successfully merging this pull request may close these issues.

2 participants