This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 27383 - Incorrect link for "encode" reference since Bikeshed conversion
Summary: Incorrect link for "encode" reference since Bikeshed conversion
Status: RESOLVED FIXED
Alias: None
Product: WHATWG
Classification: Unclassified
Component: URL (show other bugs)
Version: unspecified
Hardware: PC Linux
: P2 normal
Target Milestone: Unsorted
Assignee: Sam Ruby
QA Contact: sideshowbarker+urlspec
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-11-20 19:06 UTC by Simon Sapin
Modified: 2014-12-06 12:17 UTC (History)
3 users (show)

See Also:


Attachments

Description Simon Sapin 2014-11-20 19:06:20 UTC
In the application/x-www-form-urlencoded serializer:

> Replace outputPair's name and value with the result of running encode on them using encoding override, respectively.

"encode" incorrectly links to https://encoding.spec.whatwg.org/#encoding instead of https://encoding.spec.whatwg.org/#encode like it did before the conversion to Bikeshed.

The corresponding source in url.bs is just <a>encode</a>, so the issue is probably in the cross-reference data that Bikeshed uses.

Compare a snapshot of current master:
https://rawgit.com/whatwg/url/898cc941ed34996cd504bd345635d73b3de666a1/url.html#concept-urlencoded-serializer

And a snapshot of a recent commit, before conversion to Bikeshed:
https://rawgit.com/whatwg/url/f765c1ad6bf6e339f5ccca0476ea6ef1c1ff51cf/url.html#concept-urlencoded-serializer
Comment 2 Anne 2014-11-29 15:25:17 UTC
That first change is wrong. It should link to #encode, that's why it has title=encode.
Comment 3 Sam Ruby 2014-11-29 15:53:02 UTC
title is not sufficient for bikeshed.

Refixed: https://github.com/whatwg/url/commit/3d97d99a941ab5f3a2b78ba739078553cb3cd205
Comment 4 Anne 2014-11-29 15:55:50 UTC
It used to be sufficient in Anolis. So we may want to audit the specification since there could be many similar regressions if they are indeed not the same.
Comment 5 Sam Ruby 2014-11-29 16:22:06 UTC
Either I haven't found it, or the documentation from bikeshed isn't clear, but from I have gathered:

*) definitions are classified based on type (this part is clear in the documentation)

*) if type is not specified, bikeshed will essentially guess (how this guessing is done isn't precisely spelled out)

*) for definitions of type 'dfn' (the default), bikeshed will match text even if there are differences in case, or word endings (for example -s, -ing, etc.).

In this case, encode is a verb, and encoding is a noun.  To fix this but, I've defined encode as a 'function', and left encoding as a 'dfn'.

Hopefully this will help those who are looking for other cases where links need to be updated.
Comment 6 Sam Ruby 2014-12-06 12:17:05 UTC
I believe it is correct now.  Please reopen if not.