-
Notifications
You must be signed in to change notification settings - Fork 18k
proposal: go/doc: ITU-T URL support #67217
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
Comments
Why don't you link them with the link feature? https://go.dev/doc/comment#links |
@fzipp Oh that is fine in practice for most URLs, but my impression was that ITU-T (and, I suppose out of necessity, ITU-R) documents are so central to technology in general, that it made them seem like valid candidates for the same kind of built-in link support that RFCs currently enjoy in godoc/pkgsit mark down. |
The RFC special case support has existed since the inception of go/doc, well before the addition of general link support. Had general link support been available earlier, it's unlikely that the special case support would have been introduced. |
@fzipp Fair enough. I tend to cite |
I think only pkgsite has the RFC special case. go/doc does not. If anything I think we should move toward removing the x/pkgsite special case and other deviations from go/doc. |
There is also an issue with inconsistent link support. I wouldn't necessarily say this "strengthens" my case, but I'm going to cite it here for the purposes of tracking: The "links" solution mentioned by @fzipp has always worked nicely for paragraphs and instance comments, e.g.:
... or ...
But where it does not work is on line-ending or terminating comments, such as those found on
The reason I am bringing this up is because the so-called "built-in" RFC link support DOES work for the aforementioned line-ending comments. In other words:
|
Proposal Details
When authoring documentation meant for display via x/pkgsite, support should be added to recognize and support ITU-T recommendation URLs in the same manner
RFC XXXX
is currently supported.For instance:
Where the raw text
RFC 1234
would automatically link tohttps://www.rfc-editor.org/rfc/rfc1234.html
upon page generation, x/pkgsite should link E.123, X.411, X.501 and other "alpha series" (A-Z) documents to the appropriatehttps://www.itu.int/...
resource.It is true that placing a link (verbatim) in doc text is possible, but is undesirable for obvious reasons.
I do recall Go maintainers claiming godocs/pkgsite is not meant to be a "rich markdown system". While I agree, I would argue that ITU-T Recommendations are just as relevant/critical as RFCs, therefore they should qualify for the same consideration.
Thank you
The text was updated successfully, but these errors were encountered: