doc, tools: make type parsing more strict #19881
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
devsnek
approved these changes
Apr 8, 2018
| * `args` {void\*} A pointer to pass to the callback at exit. | ||
| * `callback` <span class="type"><void (\*)(void\*)></span> | ||
| A pointer to the function to call at exit. | ||
| * `args` <span class="type"><void\*></span> |
There was a problem hiding this comment.
were these changed so they don't trigger the type parser?
There was a problem hiding this comment.
Yes. Currently, tools/doc/html.js type-process any non-code text in any section, so it cannot define if this is a js type or something else. But the author of this section wanted the C types to be consistent in CSS style with JS types, so I've tried to conform.
BridgeAR
approved these changes
Apr 8, 2018
tools/doc/type-parser.js
Outdated
| typeLinks.push(`<span class="type"><${typeTextFull}></span>`); | ||
| throw new Error( | ||
| `Unrecognized type: '${typeTextFull | ||
| }'. Please, edit the type or update the 'tools/doc/type-parser.js'.` |
There was a problem hiding this comment.
Please concat the string instead of using a multi line template string.
There was a problem hiding this comment.
Done in the fixup commit.
BridgeAR
approved these changes
Apr 8, 2018
BridgeAR
added
the
author ready
lpinca
approved these changes
Apr 8, 2018
|
Rebased after the 0bd3da1. |
trivikr
approved these changes
Apr 9, 2018
|
Rebased. |
trivikr
approved these changes
Apr 10, 2018
vsemozhetbyt
added a commit
that referenced
this pull request
Apr 11, 2018
PR-URL: #19881 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
|
Landed in b3bff41 |
jasnell
pushed a commit
that referenced
this pull request
Apr 16, 2018
PR-URL: #19881 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
May 1, 2018
PR-URL: nodejs#19881 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesWe do many small correction PRs for doc types format. This change makes type parsing more strict to avoid these post-corrections. Wrong or undefined types would throw on doc build stage.
Main code changes:
anytype linkable (to this section).New parsing mode had detected some issues which have been fixed.
{object}here.{Cipher}here.Also, some style nits in
tools/doc/type-parser.jswere fixed.