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

Jsondoc0 doesn't output module comments. #9364

Closed
flenniken opened this Issue Oct 14, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@flenniken
Copy link

flenniken commented Oct 14, 2018

https://nim-lang.org/docs/docgen.html

The docgen0 example from the documentation above shows the json output contains the module comment from the top of the sample source file. Running the example in 0.19.0 this module comment does not appear in the json.

PMunch added a commit to PMunch/Nim that referenced this issue Oct 16, 2018

Fix nim-lang#9364 and add moduleDescription to jsondoc
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.
@PMunch

This comment has been minimized.

Copy link
Contributor

PMunch commented Oct 16, 2018

Seems to have been a strange bug, essentially it was double checking if the comment started with ## so the below example would work:

## ## This is a module description

There was also a bug were it used the jsondoc syntax for these comments (with line numbers etc.). All of this, along with some other things, have been fixed in #9396

@Araq Araq closed this in db95fad Oct 16, 2018

narimiran added a commit to narimiran/Nim that referenced this issue Oct 31, 2018

Fixes nim-lang#9364 and add moduleDescription to jsondoc (nim-lang#9396)
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.

narimiran added a commit to narimiran/Nim that referenced this issue Nov 1, 2018

Fixes nim-lang#9364 and add moduleDescription to jsondoc (nim-lang#9396)
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.

narimiran added a commit that referenced this issue Nov 1, 2018

Fixes #9364 and add moduleDescription to jsondoc (#9396)
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.

narimiran added a commit that referenced this issue Nov 1, 2018

Fixes #9364 and add moduleDescription to jsondoc (#9396)
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.

(cherry picked from commit db95fad)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment