correct italic markup in plugin stores docs #1977
Merged
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.
Summary of changes
Currently the doc file plugin_stores.rst uses
_
in a way that appears to be intended to produce italics in the final html render, which doesn't appear to be valid ReST markup for italics. It is Markdown markup for italics (hence me reading the intention of italics in the presence of the_
s).I have changed this to use (unescaped)
*
s for the italics, which works as seemed to be the desired behaviour.Checklist
the same change.
so maintainers can fix minor issues and keep your PR up to date.
More Detail
Discovered this while working on PR #1976 , looking at other places where there might be that issue, but found this related one instead.
Before (i.e. live docs here):
After (local build of docs after change):
Similar caveats to PR #1976: