Skip to content

added explanation of Url::fragment #332

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

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,9 @@ impl Url {

/// Return this URL’s fragment identifier, if any.
///
/// A fragment is the part of a url following the `#` symbol,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

URL should be capitalized as an initialism because it appears that way in all the rest of the documentation in this crate.

/// which is used to identify a location in the document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is necessarily true of every URL fragment, especially if the URL does not refer to an HTML document. Could you phrase this in a more precise way? Check out this article for inspiration.

///
/// **Note:** the parser did *not* percent-encode this component,
/// but the input may have been percent-encoded already.
pub fn fragment(&self) -> Option<&str> {
Expand Down