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

Tidy up docstrings #89

Open
jnsgruk opened this issue Apr 3, 2023 · 0 comments
Open

Tidy up docstrings #89

jnsgruk opened this issue Apr 3, 2023 · 0 comments

Comments

@jnsgruk
Copy link
Member

jnsgruk commented Apr 3, 2023

In most of the libs, specifically the snap lib, the conventions around docstrings and formatting have become disjointed. What made me notice this particularly was around how optional args are annotated in docstrings.

In general, I'd prefer not to include optionality/defaults in the Args: section where that info is already available in the function signature with type annotations, but if we're going to do it, it should at least be consistent.

Triggered from a review in #88

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

No branches or pull requests

1 participant