Skip to content
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

bad example in https://nim-lang.org/docs/docgen.html #8215

Closed
2 tasks
timotheecour opened this issue Jul 5, 2018 · 5 comments
Closed
2 tasks

bad example in https://nim-lang.org/docs/docgen.html #8215

timotheecour opened this issue Jul 5, 2018 · 5 comments
Labels
Documentation Content Related to documentation content (not generation).

Comments

@timotheecour
Copy link
Member

timotheecour commented Jul 5, 2018

The full output can be seen here: docgen_sample2.html. As you can see, the tool has extracted additional information provided to it by the compiler beyond what the doc command provides, such as pragmas attached implicitly by the compiler.

as of right now, https://nim-lang.org/docs/docgen_sample.html and https://nim-lang.org/docs/docgen_sample2.html look identical (there are no pragmas etc)

maybe a better sample.nim could be given to illustrate the difference

  • also, nim doc2 is not documented in nim --helpfull
@andreaferretti andreaferretti added the Documentation Content Related to documentation content (not generation). label Jul 6, 2018
@andreaferretti
Copy link
Collaborator

I think doc2 and doc were merged together, so now doc2 is left jsut for backwards compatibility

@PMunch
Copy link
Contributor

PMunch commented Jul 6, 2018

Yeah doc2 got renamed to doc, and doc got renamed to doc0. The idea is to deprecate the old doc. So that comparison should simply be removed, as there are no longer two commands.

timotheecour added a commit to timotheecour/Nim that referenced this issue Jul 24, 2018
@timotheecour
Copy link
Member Author

=> see PR #8418

@timotheecour
Copy link
Member Author

timotheecour commented Jul 24, 2018

@PMunch @andreaferretti I'm seeing a single line with old docs here:
srcdoc: "system/threads.nim;system/channels.nim;js/dom" (which uses old doc0)
in /Users/timothee/git_clone/nim/Nim/web/website.ini
all the rest is using srcdoc2 (which uses doc2)
not sure why this exception.
in any case, is the plan to get rid of all references of doc0 doc2 and just use doc (but keeping doc0, doc2 as undocumented cmds for backward compatibility) ?

@Araq
Copy link
Member

Araq commented Jul 24, 2018

not sure why this exception.

threads, channels only work with doc0 being include files, not sure about js/dom.

in any case, is the plan to get rid of all references of doc0 doc2 and just use doc (but keeping doc0, doc2 as undocumented cmds for backward compatibility) ?

Yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Content Related to documentation content (not generation).
Projects
None yet
Development

No branches or pull requests

4 participants