Bug 15656 – ddox should recognize special meaning of '_' in ddoc, else may generate broken links.

Status
RESOLVED
Resolution
FIXED
Severity
normal
Priority
P1
Component
dlang.org
Product
D
Version
D2
Platform
x86_64
OS
Linux
Creation time
2016-02-08T10:23:00Z
Last change time
2016-06-02T14:36:21Z
Assigned to
nobody
Creator
jansen.gerald

Comments

Comment #0 by jansen.gerald — 2016-02-08T10:23:49Z
tldr; in std/datetime.d, http://dlang.org/intro-to-_datetime.html should be http://dlang.org/intro-to-datetime.html I tried to fix this myself using the "Improve this page" but that mysteriously took me to an EMPTY datetime.d file in github: D-Programming-Language/phobos/std/datetime.d, with a warning "You’re editing a file in a project you don’t have write access to. Submitting a change to this file will write it to a new branch in your fork jansengb/phobos, so you can send a pull request." Okay, so I fork phobos in github and navigate to datetime.d. Whoa, the file is 1.38 Mb, too big to be viewed/edited in github. Okay, I give up.
Comment #1 by ag0aep6g — 2016-02-08T10:47:05Z
I suppose this is about the ddox pages [1], right? The link is broken there, but it's fine on the ddoc pages [2]. The underscore is there for a reason: Without it, "datetime" would be highlighted by ddoc, which would garble the URL, breaking the link. That ddox carries over the underscore literally seems to be a bug, or at least an incompatibility between ddox and ddoc. So, fixing this will be more complicated than just removing the underscore, unfortunately. [1] <http://dlang.org/library/std/datetime.html>, <http://dlang.org/library-prerelease/std/datetime.html> [2] <http://dlang.org/phobos/std_datetime.html>, <http://dlang.org/phobos-prerelease/std_datetime.html>
Comment #2 by jansen.gerald — 2016-02-08T11:50:48Z
(In reply to ag0aep6g from comment #1) > I suppose this is about the ddox pages [1], right? Yes. Okay so this is a ddox issue and presumably it is well known so I'll close this issue.
Comment #3 by ag0aep6g — 2016-02-08T11:56:18Z
(In reply to Gerald Jansen from comment #2) > Yes. Okay so this is a ddox issue and presumably it is well known so I'll > close this issue. I don't think it's well known. At least, this is the first time it's been pointed out to me. This may have to be fixed in ddox, but the broken links are an issue for phobos/dlang.org. So this is definitely not invalid. Reopening.
Comment #4 by ag0aep6g — 2016-02-12T16:19:08Z
I've filed an issue against ddox: https://github.com/rejectedsoftware/ddox/issues/117
Comment #5 by ag0aep6g — 2016-02-17T22:44:23Z
(In reply to ag0aep6g from comment #4) > I've filed an issue against ddox: > https://github.com/rejectedsoftware/ddox/issues/117 The ddox issue has been fixed. For the fix to reach dlang.org there will have to be a ddox release, and the dlang.org repository will have to be updated to use it.
Comment #6 by sludwig — 2016-06-02T14:36:21Z
The fixed version of the documentation has been deployed. I've opened a separate issue for the "improve this page" link bug: https://issues.dlang.org/show_bug.cgi?id=16114