Skip to content

review metadata api docstrings before release #1357

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

Closed
jku opened this issue Apr 21, 2021 · 3 comments
Closed

review metadata api docstrings before release #1357

jku opened this issue Apr 21, 2021 · 3 comments
Labels
backlog Issues to address with priority for current development goals

Comments

@jku
Copy link
Member

jku commented Apr 21, 2021

This came up in #1354: let's check that our api docstrings are consistent -- the specific case was "Optional" in the docstring:

        Arguments:
            data: metadata content as string.
            deserializer: Optional; A MetadataDeserializer instance that...

This is from a google style guide example and is used when the argument has a default value (not when the argument is a Optional[T]).

@MVrachev
Copy link
Collaborator

In pr #1329 linting failed for file tuf/api/metadata.py because of the "C0302: Too many lines in module" warning which warns for modules
with more than 1000 lines.

This is a good reminder that probably our comments are too lengthy.
@jku could you add a todo item to try to shorten our docstrings to this issue?

@sechkova sechkova added the backlog Issues to address with priority for current development goals label May 26, 2021
@MVrachev
Copy link
Collaborator

@jku do you think we need another look at the Metadata API docstrings after the revisions you made in #1456

@jku
Copy link
Member Author

jku commented Sep 2, 2021

There's a lot to improve (#1543) but I think we shouldn't block a release on any of the docstring changes...

@jku jku closed this as completed Sep 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Issues to address with priority for current development goals
Projects
None yet
Development

No branches or pull requests

3 participants