SOLT cal kit example: more formatting and typo fixes #690
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
github-actions
bot
added
the
Documentation
|
rendered version of this PR is : https://scikit-rf--690.org.readthedocs.build/en/690/examples/metrology/SOLT%20Calibration%20Standards%20Creation.html |
jhillairet
approved these changes
Jun 8, 2022
|
It's seriously frustrating, the markdown link still doesn't render correctly (but it works on my machine, so software version is also a problem). I think I'll just remove the italics. |
1. Fix the markdown formatting of the word "Preparation" by moving
the asterisks. Previously the naked asterisks are exposed, likely a
bug in the HTML formatter, the only workaround I found is removing
it.
2. Convert HTML div class alert-warning and alert-info to Sphinx's
warning and note, because they're not supported by the HTML formatter.
Also, convert HTML links to Markdown for the same reason.
3. When doing this conversion, I also found a nasty bug in the HTML
renderer - using link markups within Sphinx's warning and note sections
can create unexpected paragraph breaks. I changed the wordings a little
bit (e.g. "documentation" -> "doc") so it doesn't trigger the bug.
4. Fix a misleading typo in the shunt capacitor code comment in the R&S
example.
ideal_medium.shunt_capacitor(capacitor_open) ** ideal_medium.short()
should be
ideal_medium.capacitor(capacitor_open) ** ideal_medium.short()
Signed-off-by: Yifeng Li <tomli@tomli.me>
|
Fixed. Now ready for merge. |
Merged
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.
I found several additional problems in the HTML rendering of the Jupyter notebook. This pull request fixes them:
Fix the markdown formatting of the word "Preparation" by moving the asterisks
out of the linkcompletely. Previously the naked asterisks are exposed, likely a bug in the HTML formatter, the only workaround I found is removing it.Convert HTML div class
alert-warningandalert-infoto Sphinx'swarningandnote, because they're not supported by the HTML formatter. Also, convert HTML links to Markdown for the same reason.When doing this conversion, I also found a nasty bug in the HTML renderer - using link markups within Sphinx's warning and note sections can create unexpected paragraph breaks. I changed the wordings a little bit (e.g. "documentation" -> "doc") so it doesn't trigger the bug.
Fix a misleading typo in the shunt capacitor code comment in the R&S example.
This
should be