eb00b95d26e8f264af80f508d50ac32e50619027

Message

chore: minor documentation tweaks (#10853)

Diff

This diff is truncated to protect this page.

 1diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
 2index 605142845512dbc833eff5c00ff125d175f9598b..2bd877892385d0a3efe4d950554df0cb731cdd94 100644
 3--- a/CONTRIBUTING.md
 4+++ b/CONTRIBUTING.md
 5@@ -47,7 +47,7 @@ It should include the data gathered as indicated above, along with:
 6 2. What the correct behavior should be
 7 3. What the actual behavior is
 8 
 9-Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle
10+Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle
11 (starting with `@`) in your message.
12 
13 We will do our very best to help you.
14@@ -59,7 +59,7 @@ your suggestion.
15 
16 If you find one, comment on it so we can know there are more people supporting it.
17 
18-If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin
19+If not, you can go ahead and create an issue. Please copy to anyone relevant (e.g. plugin
20 maintainers) by mentioning their GitHub handle (starting with `@`) in your message.
21 
22 ## Submitting Pull Requests
23@@ -99,10 +99,10 @@ covering or related to what you want to add.
24 
25 If you find one, try it out and work with the author on a common solution.
26 
27-If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin
28+If not, then go ahead and submit a PR. Please copy to anyone relevant (e.g. plugin
29 maintainers) by mentioning their GitHub handle (starting with `@`) in your message.
30 
31-For any extensive change, _eg_ a new plugin, you will have to find testers to +1 your PR.
32+For any extensive change, such as a new plugin, you will have to find testers to +1 your PR.
33 
34 ----
35 
36diff --git a/README.md b/README.md
37index 4c41fad8163b4b0511c6165997dbea60431270bb..1e4b7ff70b442a1231773813152bb65c59e4e358 100644
38--- a/README.md
39+++ b/README.md
40@@ -72,7 +72,7 @@ Oh My Zsh is installed by running one of the following commands in your terminal
41 | **wget**  | `sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"`   |
42 | **fetch** | `sh -c "$(fetch -o - https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` |
43 
44-_Note that previous configuration in `.zshrc` will be placed in `.pre-oh-my-zsh`. After installation you can move configuration you want to preserve into `.zshrc`._
45+_Note that any previous `.zshrc` will be renamed to `.zshrc.pre-oh-my-zsh`. After installation, you can move the configuration you want to preserve into the new `.zshrc`._
46 
47 #### Manual inspection
48 
49@@ -117,7 +117,7 @@ _Note that the plugins are separated by whitespace (spaces, tabs, new lines...).
50 
51 #### Using Plugins
52 
53-Each plugin includes a **README**, documenting it. This README should show the aliases (if the plugin adds any) and extra goodies that are included in that particular plugin.
54+Each built-in plugin includes a **README**, documenting it. This README should show the aliases (if the plugin adds any) and extra goodies that are included in that particular plugin.
55 
56 ### Themes
57 
58@@ -140,7 +140,7 @@ ZSH_THEME="agnoster" # (this is one of the fancy ones)
59 # see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster
60 ```
61 
62-_Note: many themes require installing the [Powerline Fonts](https://github.com/powerline/fonts) in order to render properly._