Skip to content

Conversation

PMunch
Copy link
Contributor

@PMunch PMunch commented Mar 2, 2018

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.

@PMunch PMunch force-pushed the jsondoc branch 2 times, most recently from b025f38 to a161d80 Compare March 2, 2018 13:20
@ghost
Copy link

ghost commented Mar 6, 2018

Since doc2 became just doc, could this be done for jsondoc too?

@PMunch
Copy link
Contributor Author

PMunch commented Mar 7, 2018

Hmm, yeah I guess it would make sense to do the same change to jsondoc

@PMunch PMunch changed the title Update information about jsondoc/jsondoc2 Renamed jsondoc2 to jsondoc, similar to doc2 Mar 7, 2018
@PMunch
Copy link
Contributor Author

PMunch commented Mar 7, 2018

Renamed jsondoc2 now, and updated the information on doc2 which was still talking about doc2 and doc.

@Araq
Copy link
Member

Araq commented Mar 7, 2018

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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"

@Araq
Copy link
Member

Araq commented Mar 8, 2018

Also needs a changelog entry.

PMunch pushed a commit to PMunch/Nim that referenced this pull request Mar 8, 2018
Mainly spelling and syntax errors, after review from Araq ref:
nim-lang#7279
PMunch added a commit to PMunch/Nim that referenced this pull request Mar 8, 2018
Mainly spelling and syntax errors, after review from Araq ref:
nim-lang#7279
PMunch added 4 commits March 8, 2018 09:45
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
@Araq Araq merged commit 5003942 into nim-lang:devel Mar 8, 2018
zah pushed a commit to zah/grip-lang that referenced this pull request Mar 19, 2018
* 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants