-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Renamed jsondoc2 to jsondoc, similar to doc2 #7279
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
Conversation
b025f38 to
a161d80
Compare
|
Since doc2 became just doc, could this be done for jsondoc too? |
|
Hmm, yeah I guess it would make sense to do the same change to jsondoc |
|
Renamed jsondoc2 now, and updated the information on doc2 which was still talking about doc2 and doc. |
|
Superb work, but I haven't reviewed it carefully yet. |
doc/docgen.rst
Outdated
| commands. These command take either a single .nim file, outputting a single | ||
| .html file with the same base filename, or multiple .nim files, outputting | ||
| multiple .html files and, optionally, an index file. | ||
| Generation of HTML documents is done via both the ``doc`` command. This command |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"via the" (remove the "both")
doc/docgen.rst
Outdated
| .html file with the same base filename, or multiple .nim files, outputting | ||
| multiple .html files and, optionally, an index file. | ||
| Generation of HTML documents is done via both the ``doc`` command. This command | ||
| take either a single .nim file, outputting a single .html file with the same |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"takes"
doc/docgen.rst
Outdated
| module(s), which allows it to process macros. | ||
| The full output can be seen here: `docgen_sample2.html <docgen_sample2.html>`_. | ||
|
|
||
| The previous ``doc`` command, now renamed ``doc0`` runs before semantic checking |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The older version of the doc command"
|
Also needs a changelog entry. |
Mainly spelling and syntax errors, after review from Araq ref: nim-lang#7279
Mainly spelling and syntax errors, after review from Araq ref: nim-lang#7279
Manual was missing information about jsondoc2 which made it seem like it didn't exist at all. This commit adds mention of the jsondoc2 command along with an example.
doc2 was recently renamed to doc while doc was renamed to doc0. This commits renames jsondoc to jsondoc2 and jsondoc2 to jsondoc0 to behave tha same way. The documentation for doc/jsondoc was also lagging behind this change which has also been fixed. I interpreted this as a soft deprecation of doc and jsondoc and therefore removed them from the auto-complete lists.
Mainly spelling and syntax errors, after review from Araq ref: nim-lang#7279
* Update information about jsondoc/jsondoc2 Manual was missing information about jsondoc2 which made it seem like it didn't exist at all. This commit adds mention of the jsondoc2 command along with an example. * Renamed jsondoc2 similar to doc2 and updated docs doc2 was recently renamed to doc while doc was renamed to doc0. This commits renames jsondoc to jsondoc2 and jsondoc2 to jsondoc0 to behave tha same way. The documentation for doc/jsondoc was also lagging behind this change which has also been fixed. I interpreted this as a soft deprecation of doc and jsondoc and therefore removed them from the auto-complete lists.
Manual was missing information about jsondoc2 which made it seem like
it didn't exist at all. This commit adds mention of the jsondoc2
command along with an example.