-
Notifications
You must be signed in to change notification settings - Fork 282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Basic punctuation corrections #1951
Conversation
Test results for 2b3c965:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, thank you for your work @yashpandey06 ... @alemorvan would you mind taking a look at this? I know that he is correct that, while originally using either "" or "-" for bulleted items, that the current accepted method is "-" I think the replacement of the "***" with three dashes is incorrect however. Looks like a lot of the changes are OK. Let me know what you think.
@sspencerwire let me know if it's incorrect I will close this pr and raise another one |
Actually, material-mkdocs (what we use) makes no distinction for drawing a line. Markdown appears to accept it as either "***" or "---" as you have changed it. I can't find the most accepted method, but they both work today. @yashpandey06 Do you use a local copy of documentation so that you can see how your changes affect the web rendering? I'm referring to one of these options. It's not required, however it does help me to know that the changes you've proposed here actually render correctly. Let me know either way. I can always revert some changes if it turns out to have broken something. |
@sspencerwire I don't see it to be broken , so its working ....any what's your point on it !, should I close the pr do it accordingly? |
No, not yet. Let's see if @alemorvan comments back, if you are OK with waiting just a bit. |
Sure 😄 |
Actually, @yashpandey06, I was traveling before and could not check. Unordered lists are preferred to be * not -, so I misspoke above. Do you want to edit your PR? Thanks! |
OK, ignore my last (above): The problem I was seeing in the document I was editing was that the unordered list items had "mixed" formatting. The markdownlint requires you to pick one (- or *) and then stick with it throughout. So again, neither is wrong. |
@sspencerwire got it ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's see how it looks like
Author checklist (Completed by original Author)
Rocky Documentation checklist (Completed by Rocky team)