Skip to content

Documentation Fixes/Tweaks#7

Open
carmine-cassie wants to merge 3 commits intoCOMP6991UNSW:mainfrom
carmine-cassie:main
Open

Documentation Fixes/Tweaks#7
carmine-cassie wants to merge 3 commits intoCOMP6991UNSW:mainfrom
carmine-cassie:main

Conversation

@carmine-cassie
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