www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 9473] New: DDoc'd unittests should not add Example block to generated docs if there's already an Example block

reply d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473

           Summary: DDoc'd unittests should not add Example block to
                    generated docs if there's already an Example block
           Product: D
           Version: D2
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: DMD
        AssignedTo: nobody puremagic.com
        ReportedBy: hsteoh quickfur.ath.cx


--- Comment #0 from hsteoh quickfur.ath.cx 2013-02-07 15:32:41 PST ---
/**
The magic function that can do anything.
Example:
---
void main(string[] args)
{
    dotDotDotMagic();
}
---
*/
void dotDotDotMagic() { doAnything(); }

/// Ddoc'd unittest
unittest
{
    int x=1;
    dotDotDotMagic();
    assert(x==2); // wow!
}
----------------------

Currently the output will contain two Example: sections, one following the
other. They should be merged.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Feb 07 2013
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473


Andrej Mitrovic <andrej.mitrovich gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |andrej.mitrovich gmail.com


--- Comment #1 from Andrej Mitrovic <andrej.mitrovich gmail.com> 2013-02-07
16:35:02 PST ---
The problem is there could already be multiple example sections, for example
(pardon the pun):

/**
func
Example:
---
foo();
---

Example:
---
bar();
---
*/
void func() {  }

The output of this is:

void func();
    func

    Example:

    foo();



    Example:

    bar();


It seemed only natural to do the same thing with unittest.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Feb 07 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473



--- Comment #2 from hsteoh quickfur.ath.cx 2013-02-07 16:53:47 PST ---
OK. In that case, each unittest block should be in its own example section.
Right now they are all under a single section, and it looks odd that the
hand-written example section contains a couple of examples, followed by another
example section with a couple of examples, with no clear reason for the break.
It should either be a single example section for everything, or one section per
example, so that it's consistent.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Feb 07 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473


Andrej Mitrovic <andrej.mitrovich gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |pull
         AssignedTo|nobody puremagic.com        |andrej.mitrovich gmail.com


--- Comment #3 from Andrej Mitrovic <andrej.mitrovich gmail.com> 2013-02-07
17:02:22 PST ---
https://github.com/D-Programming-Language/dmd/pull/1639

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Feb 07 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473


monarchdodra gmail.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |monarchdodra gmail.com
           See Also|                            |http://d.puremagic.com/issu
                   |                            |es/show_bug.cgi?id=9727


--- Comment #4 from monarchdodra gmail.com 2013-03-16 02:58:04 PDT ---
Please also see the related:
http://d.puremagic.com/issues/show_bug.cgi?id=9727

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Mar 16 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473



--- Comment #5 from github-bugzilla puremagic.com 2013-03-17 17:47:23 PDT ---
Commits pushed to master at https://github.com/D-Programming-Language/dmd

https://github.com/D-Programming-Language/dmd/commit/42f75e19f442f94fb480ad1ada4297b1bd38b7ac
Fixes Issue 9473 - Unittest docs should each be in their own section.

https://github.com/D-Programming-Language/dmd/commit/15b5b31c931b58139211f3aae774cacc86e5b11b
Merge pull request #1639 from AndrejMitrovic/Fix9473

Issue 9473 - Unittest docs should each be in their own section.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Mar 17 2013
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9473


Andrej Mitrovic <andrej.mitrovich gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED
            Summary|DDoc'd unittests should not |Unittest docs should each
                   |add Example block to        |be in their own section
                   |generated docs if there's   |
                   |already an Example block    |


-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Mar 19 2013