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

Conversation

hackeryarn
Copy link

@hackeryarn hackeryarn commented May 9, 2017

Proposed to resolve #318.

?r @SimonSapin


This change is Reviewable

Copy link

@Hoverbear Hoverbear left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you. :)

@sigmavirus24
Copy link

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


src/lib.rs, line 887 at r1 (raw file):

    /// Return this URL’s fragment identifier, if any.
    ///
    /// A fragment refers to the part of a url follow the `#` symbol,

This should read as "the part of a url following te # symbol,"


Comments from Reviewable

@hackeryarn
Copy link
Author

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


src/lib.rs, line 887 at r1 (raw file):

Previously, sigmavirus24 (Ian Cordasco) wrote…

This should read as "the part of a url following te # symbol,"

I made a slight change to the verbiage similar to your suggestion. I thought removing the A fragment part would makes this sound awkward so I left it, but removed the refers as you suggested.


Comments from Reviewable

@sigmavirus24
Copy link

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


src/lib.rs, line 887 at r1 (raw file):

Previously, achernyak (Artem Chernyak) wrote…

I made a slight change to the verbiage similar to your suggestion. I thought removing the A fragment part would makes this sound awkward so I left it, but removed the refers as you suggested.

Sorry, I didn't want to type the whole thing out. My suggestion is different than what you wrote and is, as a whole line,

/// A fragment is the part of a url following the `#` symbol,

Specifically, replace "follow" with "following".


Comments from Reviewable

@hackeryarn
Copy link
Author

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


src/lib.rs, line 887 at r1 (raw file):

Previously, sigmavirus24 (Ian Cordasco) wrote…

Sorry, I didn't want to type the whole thing out. My suggestion is different than what you wrote and is, as a whole line,

/// A fragment is the part of a url following the `#` symbol,

Specifically, replace "follow" with "following".

This has been updated.


Comments from Reviewable

@sigmavirus24
Copy link

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


src/lib.rs, line 887 at r1 (raw file):

Previously, achernyak (Artem Chernyak) wrote…

This has been updated.

Did you push the update? It's not displaying here.


Comments from Reviewable

@hackeryarn
Copy link
Author

Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


src/lib.rs, line 887 at r1 (raw file):

Previously, sigmavirus24 (Ian Cordasco) wrote…

Did you push the update? It's not displaying here.

Sorry not sure what happened there.


Comments from Reviewable

@sigmavirus24
Copy link

:lgtm:


Review status: 0 of 1 files reviewed at latest revision, 1 unresolved discussion.


Comments from Reviewable

@sigmavirus24
Copy link

Reviewed 1 of 1 files at r2.
Review status: all files reviewed at latest revision, all discussions resolved.


Comments from Reviewable

@@ -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.

@@ -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,
/// 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.

bors-servo pushed a commit that referenced this pull request Jun 13, 2017
Add description of fragment to documentation

Fixes #318, fixes #332.

This builds on #332, and I hope addresses the comments there.

<!-- 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/357)
<!-- 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
Development

Successfully merging this pull request may close these issues.

Explain the term "fragment" in Url::fragment
4 participants