You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
-
Markdown formatting exists for a reason: if steps are chronological, a number list should be used; bulleted lists are used when explaining details specific to the preceding step or paragraph. Grammatically, sentences shouldn't be split by code boxes since it discombobulates the content. For these reasons, I downvoted this answer and will remove it when the markdown formatting issues are resolved (it doesn't need to be like my edit, as edits are merely a suggestion for the author, however there are markdown issues to be resolved)– JW0914Commented May 31, 2022 at 13:28
-
2@JW0914 Please keep in mind that markdown and HTML semantics have a purpose. You should never use single-bullets to indicate a call-out. Bullets are list items and should be used as such. Not doing so is confusing to screen reader software, at the very least. As such, I reverted your edits since they made the answer less readable. Also, numbered lists aren't needed for every flow. Answers are typically chronological in nature, and the paragraph flow is more readable unless short list items are needed. In that case, I would agree it is preferable to use a numbered list.– NotTheDr01dsCommented May 31, 2022 at 13:36
-
I have a different perspective due to the amount of complex, in-depth answers I've written (example 1, example 2, example 3, example 4, etc.). As previously stated, "...it doesn't need to be like my edit, as edits are merely a suggestion for the author,", however when lined up side-by-side, I disagree this answer in its current form is more readable.– JW0914Commented May 31, 2022 at 13:54
Add a comment
|
How to Edit
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
How to Format
-
create code fences with backticks ` or tildes ~
```
like so
``` -
add language identifier to highlight code
```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- indent code by 4 spaces
- backtick escapes
`like _so_`
- quote by placing > at start of line
- to make links (use https whenever possible)
<https://example.com>
[example](https://example.com)
<a href="https://example.com">example</a>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. windows-7), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you