Copyedit a few top-level Markdown files #2002
Merged
Conversation
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
- Make "Download from" headings to be clearer and more consistent. - Specify `sh` in applicable code fences, for syntax highlighting. - Change code spans to code blocks (fences) in a couple places. - Tiny formatting adjustments, and slight rewording around a fence.
- Add h1 heading (as most other top-level .md files have them). - Remove a misplaced empty h4 sub-heading. - Fix spelling, and slightly adjust hyphenation for clarity. - Make capitalization consistent and capitalize "Git" in "Git LFS". - If not a command or binary, replace "git" and "`git`" with "Git". - Replace "Pack" with "`Pack`" since we're talking about the type. - Make non-rendered aspects of Markdown code style more consistent.
This is only to make the information that is already there clearer. It does not attempt to update the information to be more current (nor is this an attempt to advance any kind of policy changes). - Improve consistency in use of code spans and italics. - Have all references to "semver" be the hyperlink. - Fix a minor spelling error. - Very slightly adjust punctuation for clarity and consistency.
- Add h1 heading (as most other top-level .md files have them). - Make capitalization more consistent (preferring existing style). - Adjust code formatting and italics, to clarify what is code. - Tiny punctuation change for consistency.
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.
This does some low-stakes, fairly minor copyediting of top-level
.mdfiles other than:DEVELOPMENT.md.This does not include changes to
DEVELOPMENT.mdbecause:README.md(to propose another installation method). This PR therefore only edits other.mdfiles besidesREADME.mdwhere it was quick and easy to do so.In effect this PR can be considered what was outscoped from the forthcoming PR that will propose an additional installation method, just I am doing this PR first instead of afterwards.