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

[Documentation]: Should we add Returns section to the docstrings of our get methods (get_metadata, etc.) #1097

Open
2 tasks done
pauladkisson opened this issue Sep 18, 2024 · 2 comments

Comments

@pauladkisson
Copy link
Member

pauladkisson commented Sep 18, 2024

See #1063

Code of Conduct

@pauladkisson
Copy link
Member Author

On the one hand, documentation = good, OTH simple 1-liners usually suffice to convey all the relevant info.

@h-mayorquin
Copy link
Collaborator

I am leaning toward yes as in most cases implementing them at the base interface should work for most cases so it is not a lot of work. Plus, is a uniform rule, everything should have arguments and returns...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants