Skip to content

Fix link format for changes in PR 4940 (std.numeric.gcd)#4951

Closed
wilzbach wants to merge 1 commit intodlang:masterfrom
wilzbach:link-fixup-4940
Closed

Fix link format for changes in PR 4940 (std.numeric.gcd)#4951
wilzbach wants to merge 1 commit intodlang:masterfrom
wilzbach:link-fixup-4940

Conversation

@wilzbach
Copy link
Contributor

Fixup for #4940, which was merged prematurely :/

or $(HTTPS en.wikipedia.org/wiki/Binary_GCD_algorithm, Stein's) algorithm.
an efficient algorithm such as $(LINK2 en.wikipedia.org/wiki/Euclidean_algorithm, Euclid's)
or $(LINK2 en.wikipedia.org/wiki/Binary_GCD_algorithm, Stein's) algorithm.
*/
Copy link
Member

Choose a reason for hiding this comment

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

I don't see this necessary.

Copy link
Member

Choose a reason for hiding this comment

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

This patch is wrong, you need to add the protocol if you change the macro away from HTTP/HTTPS.

@andralex
Copy link
Member

I don't mean to antagonize but please let's let this go. Thanks.

@andralex andralex closed this Dec 13, 2016
@andralex andralex reopened this Dec 13, 2016
@andralex
Copy link
Member

Actually I might be missing something - was there a problem with the way links were previously generated?

@wilzbach
Copy link
Contributor Author

Ah damn - I just read the PR mail on my phone and didn't realize that the change was already part of the PR.
-> sorry for the noise ;/

(there's the bigger discussion of deprecating HTTP/HTTPS in favor of LINK2, but that's another day)

@wilzbach wilzbach closed this Dec 13, 2016
@wilzbach wilzbach deleted the link-fixup-4940 branch December 13, 2016 05:53
@andralex
Copy link
Member

@wilzbach an epic discussion is occurring right now on irc

@CyberShadow
Copy link
Member

CyberShadow commented Dec 13, 2016

@wilzbach @aG0aep6G Andrei and I had a quick debate on IRC about HTTP/HTTPS vs. LINK2 & co. and one strong argument in favor of HTTP/HTTPS is DDoc's special handling handling of : (i.e. when the URL starts at the beginning of the line). When text is rewrapped in the editor this can put the URL at the beginning of the line, which spontaneously breaks links.

An idea we came to is to change DMD's DDoc parsing to treat : specially (as section header terminator) only when it's followed by whitespace (incl. a newline). Breakage should be minimal. With this change, moving away from HTTP/HTTPS macros would become more feasible. This can also make writing inline CSS less painful.

@MartinNowak
Copy link
Member

The perils of having reinvented source code documentation format... ;)

@aG0aep6G
Copy link
Contributor

@wilzbach @aG0aep6G Andrei and I had a quick debate on IRC about HTTP/HTTPS vs. LINK2 & co. and one strong argument in favor of HTTP/HTTPS is DDoc's special handling handling of : (i.e. when the URL starts at the beginning of the line). When text is rewrapped in the editor this can put the URL at the beginning of the line, which spontaneously breaks links.

I'm aware of that argument. I think it's rather weak, because HTTP/HTTPS still fail when the comment is indented somehow, which is common.

An idea we came to is to change DMD's DDoc parsing to treat : specially (as section header terminator) only when it's followed by whitespace (incl. a newline).

Old news ;) Sounds good to me, obviously.

@andralex
Copy link
Member

FWIW I don't indent documentation.

@andralex
Copy link
Member

@MartinNowak which one are you referring to at the time ddoc was introduced?

@aG0aep6G
Copy link
Contributor

FWIW I don't indent documentation.

Yes, you do:

/**
The type of the integral subject to checking.
*/

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.

5 participants