-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
generate.js
doc tool produces incomplete json
#1545
Comments
cc @robertkowalski? |
Honestly, I don't think anyone has really maintained the docs tool in years. long-term plan is to replace it with some other community maintained documentation generator. There is also a separate repo for it, though again, no-one maintains it. https://github.com/iojs/doc-tool |
If we just want to patch in a fix here, this might be a good first contribution for someone. Tagging it as such. Feel free to remove the label if we don't really want this to get fixed here but would rather it get fixed in the separate repo. If someone does fix it, they might also want to update the |
This problem is caused by a bug processing unordered list which is directly following a heading.
would be converted to:
Shall we also wrap the list in the JSON result? Such as:
Or shall we just leave it alone without any wrapping? |
/cc @nodejs/documentation |
Above PR added a default case to |
Doc tool produces incomplete json when it meets unordered lists that directly following a heading. Add a default case to processList function to handle the lists. PR-URL: #5966 Fixes: #1545 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Doc tool produces incomplete json when it meets unordered lists that directly following a heading. Add a default case to processList function to handle the lists. PR-URL: #5966 Fixes: #1545 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Doc tool produces incomplete json when it meets unordered lists that directly following a heading. Add a default case to processList function to handle the lists. PR-URL: #5966 Fixes: #1545 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Doc tool produces incomplete json when it meets unordered lists that directly following a heading. Add a default case to processList function to handle the lists. PR-URL: #5966 Fixes: #1545 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Doc tool produces incomplete json when it meets unordered lists that directly following a heading. Add a default case to processList function to handle the lists. PR-URL: #5966 Fixes: #1545 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
The output from
doesn't correspond to its markdown source. For example,
### Info
section is missing, both### Execution control
&### Various
sections lack expecteddesc
property.The text was updated successfully, but these errors were encountered: