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

[Feature Req.] More exhaustive example docs #16

Open
steven-murray opened this issue Sep 24, 2019 · 0 comments
Open

[Feature Req.] More exhaustive example docs #16

steven-murray opened this issue Sep 24, 2019 · 0 comments
Assignees
Labels
type: documentation Improvements or additions to documentation
Milestone

Comments

@steven-murray
Copy link
Member

Is your feature request related to a problem? Please describe.

The example docs at the moment are helpful, but don't include all possible options, and these might not be easy to find.

Describe the solution you'd like

It would be good, especially for new users, to explicitly list all options, and what they do etc.

Describe alternatives you've considered

One alternative is to just refer the user to the API docs, and make them better. This is less redundant, but may not be as visible. I'd like to get input on this. @caw11 has some good ideas.

@steven-murray steven-murray added documentation Improvements or additions to documentation enhancement labels Sep 24, 2019
@steven-murray steven-murray self-assigned this Sep 24, 2019
@steven-murray steven-murray added type: documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation enhancement labels Sep 30, 2020
@steven-murray steven-murray added this to the v1.1 milestone Jan 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant