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.

Sign up for GitHub

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

Jump to bottom

net/url: documentation - 0xAB is confusing #18642

Closed
riking opened this issue Jan 12, 2017 · 3 comments
Closed

net/url: documentation - 0xAB is confusing #18642

riking opened this issue Jan 12, 2017 · 3 comments
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.10

Comments

@riking
Copy link

riking commented Jan 12, 2017 •
edited

Please answer these questions before submitting your issue. Thanks!

What version of Go are you using (go version)?

1.8beta

What did you do?

The documentation for url.PathUnescape is confusing, as 0xAB is an actual hexadecimal byte - implying that the 0xAB byte is somehow special. https://beta.golang.org/pkg/net/url/#PathEscape

What did you expect to see?

Letters such as %YZ -> 0xYZ should be used for placeholder characters not referencing specific bytes in the context of string transformation.
@riking riking changed the title Documentation bug - 0xAB is confusing net/url: documentation - 0xAB is confusing Jan 12, 2017
@bradfitz
Copy link
Contributor

I think the very next sentence would clear up any confusion:

It returns an error if any % is not followed by two hexadecimal digits.

But sure, we can insert a word or two. I don't like %YZ, though.

@bradfitz bradfitz added this to the Go1.9Maybe milestone Jan 12, 2017
@riking
Copy link
Author

riking commented Jan 13, 2017 •
edited

Yeah… that was me struggling to come up with something that made sense.

I think the very next sentence would clear up any confusion:

It took me some googling of what U+00AB was to realize that.

@bradfitz bradfitz modified the milestones: Go1.10, Go1.9Maybe Jul 20, 2017
@bradfitz bradfitz added the NeedsFix The path to resolution is known, but the work has not been done. label Jul 20, 2017
@gopherbot
Copy link

Change https://golang.org/cl/77050 mentions this issue: net/url: clarify QueryUnescape and PathUnescape doc

@golang golang locked and limited conversation to collaborators Nov 14, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.10
Development

No branches or pull requests
3 participants
@bradfitz @riking @gopherbot