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

Add more examples to docs #14

Open
Technologicat opened this issue Nov 27, 2020 · 0 comments
Open

Add more examples to docs #14

Technologicat opened this issue Nov 27, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@Technologicat
Copy link
Owner

The documentation could use more code examples of how to use the various features of mcpyrate. Each item should include the actual code example, an explanation of what is it for and what it does, and if applicable, the output printed by the example.

Particularly, the mcpyrate.debug.step_expansion macro would be nice to showcase in a more detailed manner.

But basically anything in the public API (i.e. in the magic __all__ of any module) could be demonstrated, starting with the most important tools.

There's a certain balance to keep here - documenting every last detail may lead to software ossification. Minute details belong in docstrings; the documentation should explain the main points and aid the discoverability of features.

@Technologicat Technologicat added the documentation Improvements or additions to documentation label Nov 27, 2020
@Technologicat Technologicat added this to the 3.1.0 milestone Nov 27, 2020
@Technologicat Technologicat added the good first issue Good for newcomers label Nov 27, 2020
@Technologicat Technologicat modified the milestones: 3.1.0, 3.2.0 Feb 11, 2021
@Technologicat Technologicat modified the milestones: 3.2.0, 3.3.0 Apr 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant