fix docs & examples #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- in `lib.rs`:
- limit the doc line length to 99 chars.
- reformat the "further resources" section.
- add an inner link in the first paragraph to the first resource.
- change the phrase "all colors in Ark will now be" to "all colors are".
- add links to `spaces` & `states` modules in "Overview" section.
- fix typos (*charcter*, *acces*, *A you*).
- fix doc examples:
- `encoded.to_u8()` → `encoded.to_u8().raw`.
- `color::srgb_u8(225, 200, 86)` → `color::srgb_u8(225, 200, 86).to_f32()`.
- in `traits.rs`:
- fix doc example:
- `color::srgb_u8(225, 200, 86)` → `color::srgb_u8(225, 200, 86).to_f32()`.
- limit the doc line length to 99 chars.
- fix typos (*howver*).
|
Thanks so much! These were all things on my list to do before next RC release but didn't have time to clean it up yet :) |
|
The ci failure isn't your fault so merging anyway. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi! first of all thank for creating this wonderful crate. I'm learning to work with color and I'm very happy having found your project, since it has a lot of depth and growth potential, while being simple to use in a way that I like very much.
While I was learning to use it I realized I could help fixing some things: three examples that didn't compile, some typos & links and I also limited the doc line lenghts on a couple of source files to make them easier to be read from the source files. More specifically:
lib.rs:spaces&statesmodules in "Overview" section.encoded.to_u8()→encoded.to_u8().raw.color::srgb_u8(225, 200, 86)→color::srgb_u8(225, 200, 86).to_f32().traits.rs:color::srgb_u8(225, 200, 86)→color::srgb_u8(225, 200, 86).to_f32().I could've kept going on but I didn't wanted to intrude too much. I hope you like it or at least don't mind my PR, and please feel free to accept or reject it or ask for any changes you want, or anything.