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

Documentation Fixes/Tweaks #7

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

Diordnas
Copy link

This pull request fixes a documentation error and proposes two tweaks to the documentation.

The top-level crate documentation is fixed to properly use //! instead of ///, meaning that it will properly appear on the home page of the html documentation. (Resolves #4.)

The documentation for the COLORS array has been modified to include array indices in the list of colours, so that a user doesn't have to count the dot points to determine, for example, that white is index 7.

The documentation for the save_png and save_svg functions are expanded to include reasons why a user might choose to use one over the other.

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.

Crate-Level Documentation Incorrect
1 participant