You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'll probably take care of this one myself, just so you know.
Rustdoc is nice and all, but a lot of crates lack the really crucial last step: a high-level guide that goes through common use cases. Giving people documentation on everything in the library isn't useful if people need to search all of that just to figure out how to do the thing they want to do.
I'm thinking worked code examples, that compile and do useful things, for things that people might want to do:
Generate a triadic color scheme
Equalize colors by luminance
Compare the difference in various methods of getting grayscale versions of a color
Replicate the famous Wright-Guild experiment (ok, probably better as a demo)
With something like this, where it's hard to explain what it does clearly to anyone who isn't a color scientist, it's especially important to have some cool demo or something that people can look at and then see parts of that functionality that they wanna use.
The text was updated successfully, but these errors were encountered:
I'll probably take care of this one myself, just so you know.
Rustdoc is nice and all, but a lot of crates lack the really crucial last step: a high-level guide that goes through common use cases. Giving people documentation on everything in the library isn't useful if people need to search all of that just to figure out how to do the thing they want to do.
I'm thinking worked code examples, that compile and do useful things, for things that people might want to do:
With something like this, where it's hard to explain what it does clearly to anyone who isn't a color scientist, it's especially important to have some cool demo or something that people can look at and then see parts of that functionality that they wanna use.
The text was updated successfully, but these errors were encountered: