Skip to content
This repository has been archived by the owner on Aug 15, 2024. It is now read-only.

Add more docstrings to python methods #169

Open
jonespm opened this issue May 23, 2022 · 0 comments
Open

Add more docstrings to python methods #169

jonespm opened this issue May 23, 2022 · 0 comments
Labels
backend documentation Improvements or additions to documentation

Comments

@jonespm
Copy link
Member

jonespm commented May 23, 2022

Something I'd like to get better about (again) is using docstrings. I used these consistently in Java and more consistently in MyLA but I think not as much here. There's an extension for this but I'm not sure the format. to use. Sphinx and "one-line Sphnix" seem the most popular but Google looks easiest to read, though taking up more space.

We can go back and do this on another issue too, or start with this one!

Originally posted by @jonespm in #167 (comment)

@ssciolla ssciolla added documentation Improvements or additions to documentation backend labels Jun 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backend documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants