8000 Minor format-change suggestions for README.md · daniel4git/github-cheat-sheet@2e99847 · GitHub
[go: up one dir, main page]

Skip to content < 8000 span style="width: 0%;" data-view-component="true" class="Progress-item progress-pjax-loader-bar left-0 top-0 color-bg-accent-emphasis">

Commit 2e99847

Browse files
authored
Minor format-change suggestions for README.md
1 parent 9399a56 commit 2e99847

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ A collection of cool hidden and not so hidden features of Git and GitHub. This c
7979

8080
## GitHub
8181
### Ignore Whitespace
82-
Adding `?w=1` to any diff URL will remove any changes only in whitespace, enabling you to see only that code that has changed.
82+
Adding `?w=1` to any diff URL will remove any changes only in whitespace, enabling you to see only the code that has changed.
8383

8484
![Diff without whitespace](https://camo.githubusercontent.com/797184940defadec00393e6559b835358a863eeb/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f626c6f672f323031312f736563726574732f776869746573706163652e706e67)
8585

@@ -138,7 +138,7 @@ To use GitHub to compare branches, change the URL to look like this:
138138
https://github.com/{user}/{repo}/compare/{range}
139139
```
140140

141-
Where `{range} = master...4-1-stable`
141+
where `{range} = master...4-1-stable`
142142

143143
For example:
144144

@@ -155,7 +155,7 @@ https://github.com/rails/rails/compare/master@{1.day.ago}...master
155155
https://github.com/rails/rails/compare/master@{2014-10-04}...master
156156
```
157157

158-
*Dates are in the format `YYYY-MM-DD`*
158+
*Here, dates are in the format `YYYY-MM-DD`*
159159

160160
![Another compare example](http://i.imgur.com/5dtzESz.png)
161161

@@ -188,7 +188,7 @@ https://github.com/rails/rails/compare/byroot:master...master
188188

189189
![Gist](http://i.imgur.com/VkKI1LC.png?1)
190190

191-
Add `.pibb` to the end of any Gist URL ([like this](https://gist.github.com/tiimgreen/10545817.pibb)) in order to get the *HTML only* version suitable for embedding in any other site.
191+
Add `.pibb` to the end of any Gist URL ([like this](https://gist.github.com/tiimgreen/10545817.pibb)) in order to get the *HTML-only* version suitable for embedding in any other site.
192192

193193
Gists can be treated as a repository so they can be cloned like any other:
194194

@@ -236,7 +236,7 @@ When on a repository page, keyboard shortcuts allow you to navigate easily.
236236
- Pressing `w` will bring up the branch selector.
237237
- Pressing `s` will focus the search field for the current repository. Pressing Backspace to delete the “This repository” pill changes the field to search all of GitHub.
238238
- Pressing `l` will edit labels on existing Issues.
239-
- Pressing `y` **when looking at a file** (e.g. `https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md`) will change your URL to one which, in effect, freezes the page you are looking at. If this code changes, you will still be able to see what you saw at that current time.
239+
- Pressing `y` **when looking at a file** (e.g., `https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md`) will change your URL to one which, in effect, freezes the page you are looking at. If this code changes, you will still be able to see what you saw at that current time.
240240

241241
To see all of the shortcuts for the current page press `?`:
242242

@@ -245,9 +245,9 @@ To see all of the shortcuts for the current page press `?`:
245245
[Read more about search syntax you can use.](https://help.github.com/articles/search-syntax/)
246246

247247
### Line Highlighting in Repositories
248-
Either adding `#L52` to the end of a code file URL or simply clicking the line number will highlight that line number.
248+
Either adding, e.g., `#L52` to the end of a code file URL or simply clicking the line number will highlight that line number.
249249

250-
It also works with ranges, e.g. `#L53-L60`, to select ranges, hold `shift` and click two lines:
250+
It also works with ranges, e.g., `#L53-L60`, to select ranges, hold `shift` and click two lines:
251251

252252
```
253253
https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60
@@ -271,7 +271,7 @@ This closes the issue and references the closing commit.
271271
### Cross-Link Issues
272272
If you want to link to another issue in the same repository, simply type hash `#` then the issue number, and it will be auto-linked.
273273

274-
To link to an issue in another repository, `{user}/{repo}#ISSUE_NUMBER` e.g. `tiimgreen/toc#12`.
274+
To link to an issue in another repository, `{user}/{repo}#ISSUE_NUMBER`, e.g., `tiimgreen/toc#12`.
275275

276276
![Cross-Link Issues](https://camo.githubusercontent.com/447e39ab8d96b553cadc8d31799100190df230a8/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f626c6f672f323031312f736563726574732f7265666572656e6365732e706e67)
277277

@@ -478,7 +478,7 @@ Relative links are recommended in your Markdown files when linking to internal c
478478
[Link to a file](docs/readme)
479479
```
480480

481-
Absolute links have to be updated whenever the URL changes (e.g. repository renamed, username changed, project forked). Using relative links makes your documentation easily stand on its own.
481+
Absolute links have to be updated whenever the URL changes (e.g., repository renamed, username changed, project forked). Using relative links makes your documentation easily stand on its own.
482482

483483
[*Read more about relative links.*](https://help.github.com/articles/relative-links-in-readmes/)
484484

@@ -522,7 +522,7 @@ You can revert it by clicking the **Revert** button on the right side of a commi
522522

523523
### Diffs
524524
#### Rendered Prose Diffs
525-
Commits and pull requests, including rendered documents supported by GitHub (e.g. Markdown), feature *source* and *rendered* views.
525+
Commits and pull requests, including rendered documents supported by GitHub (e.g., Markdown), feature *source* and *rendered* views.
526526

527527
![Source / Rendered view](https://github-images.s3.amazonaws.com/help/repository/rendered_prose_diff.png)
528528

@@ -723,15 +723,15 @@ You can get a list of public ssh keys in plain text format by visiting:
723723
https://github.com/{user}.keys
724724
```
725725

726-
e.g. [https://github.com/tiimgreen.keys](https://github.com/tiimgreen.keys)
726+
e.g., [https://github.com/tiimgreen.keys](https://github.com/tiimgreen.keys)
727727

728728
[*Read more about accessing public ssh keys.*](https://changelog.com/github-exposes-public-ssh-keys-for-its-users/)
729729

730730
### Checking out Pull Requests
731731

732732
Pull Requests are special branches on the GitHub repository which can be retrieved locally in several ways:
733733

734-
Retrieve a specific Pull Request and store it temporarily in `FETCH_HEAD` for quickly `diff`ing or `merge`ing:
734+
Retrieve a specific Pull Request and store it temporarily in `FETCH_HEAD` for quickly `diff`-ing or `merge`-ing:
735735

736736
```bash
737737
$ git fetch origin refs/pull/[PR-Number]/head
@@ -803,7 +803,7 @@ Running:
803803
$ git status
804804
```
805805

806-
Produces:
806+
produces:
807807

808808
![git status](http://i.imgur.com/qjPyvXb.png)
809809

@@ -813,7 +813,7 @@ By adding `-sb`:
813813
$ git status -sb
814814
```
815815

816-
This is produced:
816+
this is produced:
817817

818818
![git status -sb](http://i.imgur.com/K0OY3nm.png)
819819

@@ -826,7 +826,7 @@ Running:
826826
$ git log --all --graph --pretty=format:'%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative
827827
```
828828

829-
Produces:
829+
produces:
830830

831831
![git log --all --graph --pretty=format:'%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative](http://i.imgur.com/58eOtkW.png)
832832

@@ -843,7 +843,7 @@ A Git query allows you to search all your previous commit messages and find the
843843
$ git show :/query
844844
```
845845

846-
Where `query` (case-sensitive) is the term you want to search, this then finds the last one and gives details on the lines that were changed.
846+
where `query` (case-sensitive) is the term you want to search, this then finds the last one and gives details on the lines that were changed.
847847

848848
```bash
849849
$ git show :/typo
@@ -869,7 +869,7 @@ will show all the files containing the string *aliases*.
869869

870870
You can also use multiple flags for more advanced search. For example:
871871

872-
* `-e` The next parameter is the pattern (e.g. regex)
872+
* `-e` The next parameter is the pattern (e.g., regex)
873873
* `--and`, `--or` and `--not` Combine multiple patterns.
874874

875875
Use it like this:
@@ -886,15 +886,15 @@ Running:
886886
$ git branch --merged
887887
```
888888

889-
Will give you a list of all branches that have been merged into your current branch.
889+
will give you a list of all branches that have been merged into your current branch.
890890

891891
Conversely:
892892

893893
```bash
894894
$ git branch --no-merged
895895
```
896896

897-
Will give you a list of branches that have not been merged into your current branch.
897+
will give you a list of branches that have not been merged into your current branch.
898898

899899
[*Read more about the Git `branch` command.*](http://git-scm.com/docs/git-branch)
900900

@@ -914,7 +914,7 @@ Use the Git `instaweb` command to instantly browse your working repository in `g
914914
$ git instaweb
915915
```
916916

917-
Opens:
917+
opens:
918918

919919
![Git instaweb](http://i.imgur.com/Dxekmqc.png)
920920

0 commit comments

Comments
 (0)
0