-
Notifications
You must be signed in to change notification settings - Fork 330
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
Document the percent_encoding module #298
Comments
If one doesn’t know whether they need a custom encode set, they probably don’t. This a fairly advanced feature, almost an "escape hatch". While it should be documented in the sense that everything should be documented, it shouldn’t be featured prominently in the module’s or crate’s documentation. I wish rustdoc was prose-oriented like Sphinx, and let crate authors/maintainers choose what items to show first and generally how to organize docs. |
Percent encoding docs Fixes #298, fixes #355. This is a rebase of #355 with some additional changes. Original work by @AndyGauge. <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/rust-url/361) <!-- Reviewable:end -->
This module encapsulates a crate-specific pattern that could be explained better.
Some things that might clarify my questions about this module:
EncodeSet
The text was updated successfully, but these errors were encountered: