Thread overview
[Issue 18022] DDoc should place documented unittests after overloads
[Issue 18022] DDoc: reduce ddoc has UT between documentation
Dec 04, 2017
RazvanN
Dec 04, 2017
John Hall
Dec 04, 2017
John Hall
Dec 17, 2022
Iain Buclaw
December 04, 2017
https://issues.dlang.org/show_bug.cgi?id=18022

RazvanN <razvan.nitu1305@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
                 CC|                            |razvan.nitu1305@gmail.com
         Resolution|---                         |INVALID

--- Comment #1 from RazvanN <razvan.nitu1305@gmail.com> ---
This is not a bug, but a documented unittest. Closing as invalid.

--
December 04, 2017
https://issues.dlang.org/show_bug.cgi?id=18022

--- Comment #2 from John Hall <john.michael.hall@gmail.com> ---
(In reply to RazvanN from comment #1)
> This is not a bug, but a documented unittest. Closing as invalid.

I'm not happy with this decision.

I understand what a documented unittest is. The problem is the ordering. Right now, for functions like reduce, it goes

1) some template-level documentation
2) unittests
3) the functions

I believe it should go

1) some template-level documentation
2) the functions
3) unittests

For other examples, I noticed it in mir-algorithm, which depends on ddoc. See
http://docs.algorithm.dlang.io/latest/mir_ndslice_topology.html#map
the actual map function where it has the returns is all the way at the end

--
December 04, 2017
https://issues.dlang.org/show_bug.cgi?id=18022

Steven Schveighoffer <schveiguy@yahoo.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
                 CC|                            |schveiguy@yahoo.com
         Resolution|INVALID                     |---
            Summary|DDoc: reduce ddoc has UT    |DDoc should place
                   |between documentation       |documented unittests after
                   |                            |overloads

--- Comment #3 from Steven Schveighoffer <schveiguy@yahoo.com> ---
John Hall, it's not a bad suggestion, and definitely the documentation could be presented differently.

However, this is functionality of the documentation generator, not phobos itself. So this would have to be an enhancement to the documentation generator, which I think you understood, but maybe the title throws people off. I'm updating the title and reopening.

--
December 04, 2017
https://issues.dlang.org/show_bug.cgi?id=18022

Steven Schveighoffer <schveiguy@yahoo.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |ddoc

--
December 04, 2017
https://issues.dlang.org/show_bug.cgi?id=18022

--- Comment #4 from John Hall <john.michael.hall@gmail.com> ---
Okay.

--
December 17, 2022
https://issues.dlang.org/show_bug.cgi?id=18022

Iain Buclaw <ibuclaw@gdcproject.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Priority|P1                          |P4

--
December 13
https://issues.dlang.org/show_bug.cgi?id=18022

--- Comment #5 from dlangBugzillaToGithub <robert.schadek@posteo.de> ---
THIS ISSUE HAS BEEN MOVED TO GITHUB

https://github.com/dlang/dmd/issues/19337

DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB

--