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.

Sign up for GitHub

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

Jump to bottom

Switch libraries to Google Style doc strings? #607

Closed
tannewt opened this issue Feb 8, 2018 · 2 comments
Closed

Switch libraries to Google Style doc strings? #607

tannewt opened this issue Feb 8, 2018 · 2 comments
Labels
documentation
Milestone
Long term

Comments

@tannewt
Copy link
Member

tannewt commented Feb 8, 2018

Google style docstrings are easier to read as plain text. However, the inline docs we have for the core APIs can only be rST because they aren't extracted from Python files.

Do we still want to switch to Google Style for libraries?
@tannewt tannewt added this to the Long term milestone Feb 8, 2018
@tannewt
Copy link
Member Author

tannewt commented Feb 8, 2018

We should merge adafruit/cookiecutter-adafruit-circuitpython#17 if we decide to.

@tannewt tannewt mentioned this issue Feb 8, 2018
Merged
@tannewt
Copy link
Member Author

tannewt commented Jul 3, 2018

Too hard.

@tannewt tannewt closed this as completed Jul 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
Long term
Development

No branches or pull requests
1 participant
@tannewt