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

Document the percent_encoding module #298

Closed
brson opened this issue May 4, 2017 · 1 comment · Fixed by #361
Closed

Document the percent_encoding module #298

brson opened this issue May 4, 2017 · 1 comment · Fixed by #361

Comments

@brson
Copy link
Contributor

brson commented May 4, 2017

This module encapsulates a crate-specific pattern that could be explained better.

Some things that might clarify my questions about this module:

  • Module level explanation of what "percent encoding" is and the role of EncodeSet
  • Module level examples of creating and using encode sets
  • Do users ever need to create their own encode sets?
  • When do users need to use this module?
  • Examples on the free functions and EncodeSet
  • Documentation of which characters are in each predefined EncodeSet
@SimonSapin
Copy link
Member

Do users ever need to create their own encode sets?

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.

bors-servo pushed a commit that referenced this issue Jun 13, 2017
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 -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants