summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvladislav doster <mvdoster@gmail.com>2021-12-31 01:55:01 -0600
committerMarc Cornellà <hello@mcornella.com>2021-12-31 20:19:40 +0100
commit9c01dbc30bdfedebb986190309106d01d49f9851 (patch)
tree857f79408406bd7468de5899769cc718b8fc788f
parent376beafd17b5e9aeb5ef9975720e4ad3354c0f43 (diff)
downloadzsh-9c01dbc30bdfedebb986190309106d01d49f9851.tar.gz
zsh-9c01dbc30bdfedebb986190309106d01d49f9851.tar.bz2
zsh-9c01dbc30bdfedebb986190309106d01d49f9851.zip
chore(python): minor corrections on README (#10548)
Closes #10548
-rw-r--r--plugins/python/README.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/plugins/python/README.md b/plugins/python/README.md
index 4968cca6d..c1f0adef8 100644
--- a/plugins/python/README.md
+++ b/plugins/python/README.md
@@ -1,8 +1,8 @@
-# python plugin
+# Python plugin
-The plugin adds several aliases for useful [python](https://www.python.org/) commands.
+The plugin adds several aliases for useful [Python](https://www.python.org/) commands.
-To use it, add `python` to the plugins array of your zshrc file:
+To use it, add `python` to the plugins array in your zshrc file:
```zsh
plugins=(... python)
@@ -10,16 +10,15 @@ plugins=(... python)
## Aliases
-<<<<<<< HEAD
-| Command | Description |
-| ---------------- | ------------------------------------------------------------------------------------- |
-| `py` | Runs `python` |
-| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv |
-| `pyfind` | Finds .py files recursively in the current directory |
-| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one |
-| `pygrep <text>` | Looks for `text` in .py files |
-| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. |
-| `pyserver` | Starts an http.server on the current directory. Use `--directory` for a different one |
+| Command | Description |
+| ---------------- | -------------------------------------------------------------------------------------- |
+| `py` | Runs `python` |
+| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv |
+| `pyfind` | Finds .py files recursively in the current directory |
+| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one |
+| `pygrep <text>` | Looks for `text` in `*.py` files in the current directory, recursively |
+| `pyuserpaths` | Add user site-packages folders to `PYTHONPATH`, for Python 2 and 3 |
+| `pyserver` | Starts an HTTP server on the current directory (use `--directory` for a different one) |
## Virtual environments