Refactor htmlToMd.ts: Split prepareHandlers function
#943
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
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 |
arnaucasau
commented
Mar 1, 2024
| }); | ||
| } | ||
|
|
||
| function buildDt( |
There was a problem hiding this comment.
Same logic as before but encapsulated in a helper function
Comment on lines
-105
to
-112
| if (node.properties.id && node.properties.className?.includes("target")) { | ||
| if ( | ||
| node.properties.id && | ||
| (node.properties.className?.includes("target") || | ||
| node.children.length === 0) | ||
| ) { | ||
| return [buildSpanId(node.properties.id), ...all(h, node)]; | ||
| } | ||
|
|
||
| if (node.properties.id && node.children.length === 0) { | ||
| return buildSpanId(node.properties.id); | ||
| } | ||
|
|
There was a problem hiding this comment.
The difference between these two ifs was the call to all(h, node). This merge should be safe given that the all method transforms the children of a hast parent to mdast or returns an empty array if no children are found.
Description of the function at https://github.com/syntax-tree/hast-util-to-mdast?tab=readme-ov-file#fields-1
Eric-Arellano
approved these changes
Mar 1, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Part of Qiskit#845 This PR refactors the `htmlToMd.ts` script. It splits the `prepareHandlers` function into some helper functions to simplify the logic and improve the readability.
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.
Part of #845
This PR refactors the
htmlToMd.tsscript. It splits theprepareHandlersfunction into some helper functions to simplify the logic and improve the readability.