Skip to content

Organizing Helpers list #189

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

Merged
merged 7 commits into from
Aug 30, 2019
Merged

Organizing Helpers list #189

merged 7 commits into from
Aug 30, 2019

Conversation

brentru
Copy link
Member

@brentru brentru commented Aug 28, 2019

This is an initial pass at organizing the helper library list within drivers.rst into specific helper library categories.

Suggestions and improvements are appreciated.

@brentru brentru requested a review from a team August 28, 2019 16:35
Copy link
Contributor

@kattni kattni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this! One suggestion to consider below.

Copy link
Contributor

@kattni kattni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, thank you for the updates. Feel free to merge when passing.

@brentru
Copy link
Member Author

brentru commented Aug 28, 2019

@kattni thx - I think we could have explanations about each category, similar to drivers..but we might be able to omit this if our categories are self-explanatory enough?

@kattni
Copy link
Contributor

kattni commented Aug 28, 2019

@brentru If we're going to put in explanations for any of them, we should put them in for all of them, regardless of how self-explanatory they are. I do agree this might be a good idea. One sentence explaining the category may be useful.

@brentru
Copy link
Member Author

brentru commented Aug 28, 2019

@kattni I added per-helper category descriptions in the latest commit.

Copy link
Contributor

@kattni kattni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll have to look up formatting, but please format the category titles as some sort of sub-header or bold of some sort. At the moment, it's difficult to read.

@brentru
Copy link
Member Author

brentru commented Aug 30, 2019

@kattni Added appropriate header level formatting.

(also, TIL about the sphinx style guide... https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html#headings)

Copy link
Contributor

@kattni kattni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thank you for doing this!

@kattni
Copy link
Contributor

kattni commented Aug 30, 2019

@brentru Sphinx failed with a styling error. Feel free to merge once everything is passing.

@brentru brentru merged commit 96b0776 into adafruit:master Aug 30, 2019
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

Successfully merging this pull request may close these issues.

3 participants