docs: fix two markdown formatting errors in README#1297
Closed
redstartechno wants to merge 1 commit into
Closed
Conversation
- line 24: close italic caption with a single * (was **), fixing unbalanced emphasis - line 52: drop stray '(or repo name)**' from the clone code block so the command is clean
Author
|
Closing in favor of #1306, which combines this and the other docs fixes into a single PR per the maintainer's request. Thanks! |
This file contains hidden or 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
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.
What problem does this solve?
Two small Markdown errors in the top-level
README.mdrender incorrectly. One breaks anitalic caption; the other puts invalid text into a copy-paste shell command in the
"Build the project" section.
How do you know this is a real problem?
*but closes with**:*[Work in progress] Diagram 1. The Task flow [Source](docs/papers/InferenceFlow.png)**.The unbalanced markers mean the line does not render as intended italic.
instructions read
cd gonka (or repo name)**. The trailing**and the parentheticalare stray editing leftovers; a reader copying the block runs an invalid command.
How does this solve the problem?
*.cd gonka.What risks does this introduce? How can we mitigate them?
None. This is a documentation-only change with no runtime behavior impact. The change is
confined to README prose/formatting, so blast radius is a single file.
How do you know this PR fixes the problem?
Verified the rendered Markdown: the caption now renders as a single italic line, and the
code block now shows a clean, copy-pasteable
cd gonka. See the before/after diff below.Which components are affected?
README.mdonly.Testing & evidence
No code paths changed; automated tests are not applicable to this documentation-only change.