Fix warnings in documentation rst files. #90
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
Bolding was incorrectly written with a single `*` and
was interpretted as a single item list with trailing `*`.
fixes:
```
docs/components/ory/technical.rst:23:
WARNING: Bullet list ends without a blank line; unexpected unindent.
```
Removes the leading space from the bold/strong
end tag because it was binding to the :: code
block tag and confusing the parser.
```
docs/components/ory/usage.rst:14:
WARNING: Inline strong start-string without end-string.
docs/components/ory/usage.rst:33:
WARNING: Inline strong start-string without end-string.
```
Title underline must be at least as long as the text it is underlining.
This is only a warning condition and does not affect the rendered html.
Fixes:
```
docs/components/ory/usage.rst:56:
WARNING: Title underline too short.
```
|
If this PR is useful, I'd appreciate if you could add a label of "hacktoberfest-accepted". |
kayibal
approved these changes
Oct 18, 2021
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.
Fixes the current warnings in docs/**/*rst files