Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #1440 from harshanarayana/fix/Contribution_Guide_Pip_Install

Browse Source 
fix minor type and pip install instruction mismatch
This commit is contained in:
7 2018-12-28 18:43:41 -08:00 committed by GitHub
commit 72f2e18a84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -57,7 +57,7 @@ To install sanic without uvloop or ujson using bash, you can provide either or b
using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the ``SANIC_NO_X`` (``X`` = ``UVLOOP``/``UJSON``) using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the ``SANIC_NO_X`` (``X`` = ``UVLOOP``/``UJSON``)
to true will stop that features installation. to true will stop that features installation.
- ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip install sanic`` - ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip3 install sanic``
Hello World Example Hello World Example

4
docs/sanic/contributing.rst
View File

@ -16,7 +16,7 @@ directory with a virtual environment already set up, then run:
.. code:: bash .. code:: bash
pip3 install -e . '[.dev]' pip3 install -e '.[dev]'
Dependency Changes Dependency Changes
------------------ ------------------
@ -35,7 +35,7 @@ the document that explains the way ``sanic`` manages dependencies inside the ``s
| extras_require['test'] | for ``sanic`` | | | extras_require['test'] | for ``sanic`` | |
+------------------------+-----------------------------------------------+--------------------------------+ +------------------------+-----------------------------------------------+--------------------------------+
| extras_require['dev'] | Additional Development requirements to add | ``pip3 install -e '.[dev]'`` | | extras_require['dev'] | Additional Development requirements to add | ``pip3 install -e '.[dev]'`` |
| | contributing | | | | for contributing | |
+------------------------+-----------------------------------------------+--------------------------------+ +------------------------+-----------------------------------------------+--------------------------------+
| extras_require['docs'] | Dependencies required to enable building and | ``pip3 install -e '.[docs]'`` | | extras_require['docs'] | Dependencies required to enable building and | ``pip3 install -e '.[docs]'`` |
| | enhancing sanic documentation | | | | enhancing sanic documentation | |