Split sphinxHtmlToMarkdown into helper functions #596
Merged
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
Eric-Arellano
commented
Jan 8, 2024
Comment on lines
-39
to
+43
| imageDestination?: string; | ||
| imageDestination: string; | ||
| // url links to a fixed version and ending in / | ||
| // https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/ | ||
| baseSourceUrl?: string; | ||
| releaseNotesTitle?: string; | ||
| baseSourceUrl: string; | ||
| releaseNotesTitle: string; |
There was a problem hiding this comment.
These were only optional for the sake of testing. But that's a dangerous strategy because it's really important that production never forget to set the arguments.
| addLanguageClassToCodeBlocks($, $main); | ||
| replaceSourceLinksWithGitHub($, $main, baseSourceUrl); | ||
| convertRubricsToHeaders($, $main); | ||
| processSimpleFieldLists($, $main); |
There was a problem hiding this comment.
I don't like this name very much, but I still don't understand well all the edge cases of what this function is doing. We should rename it once we have a better understanding of the semantic significance.
| convertRubricsToHeaders($, $main); | ||
| processSimpleFieldLists($, $main); | ||
| removeColons($main); | ||
| preserveMathBlockWhitespace($, $main); |
There was a problem hiding this comment.
This used to happen later in the sequence. I moved it here because it "fits" better here with the other processing.
| } | ||
|
|
||
| /** | ||
| * Convert sphinx-design tabs. |
There was a problem hiding this comment.
This comment is new.
frankharkins
approved these changes
Jan 9, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Part of Qiskit#223. There are still improvements we can make like better testing. This PR tries to avoid making code changes and only moves the code to helper functions.
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 #223. There are still improvements we can make like better testing.
This PR tries to avoid making code changes and only moves the code to helper functions.