Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify explicit language for literal blocks in CONTRIBUTING.rst to reduce warnings in doc builds #760

Merged
merged 1 commit into from
Apr 10, 2022
Merged

Specify explicit language for literal blocks in CONTRIBUTING.rst to reduce warnings in doc builds #760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,25 +51,33 @@ We expect you to use a python virtual environment to run our tests.

There are several ways to make a virtual environment.

If you like to use *virtualenv* please run::
If you like to use *virtualenv* please run:

.. code-block:: sh

$ cd aiomysql
$ virtualenv --python=`which python3` venv
$ virtualenv --python="$(which python3)" venv

For standard python *venv*:

For standard python *venv*::
.. code-block:: sh

$ cd aiomysql
$ python3 -m venv venv

For *virtualenvwrapper*::
For *virtualenvwrapper*:

.. code-block:: sh

$ cd aiomysql
$ mkvirtualenv --python=`which python3` aiomysql
$ mkvirtualenv --python="$(which python3)" aiomysql

There are other tools like *pyvenv* but you know the rule of thumb
now: create a python3 virtual environment and activate it.

After that please install libraries required for development::
After that please install libraries required for development:

.. code-block:: sh

$ pip install -r requirements-dev.txt

Expand All @@ -83,7 +91,7 @@ use this values by default. But you always can override host/port, user and
password in `aiomysql/tests/base.py` file or install corresponding environment
variables. Tests require two databases to be created before running suit:

::
.. code-block:: sh

$ mysql -u root
mysql> CREATE DATABASE test_pymysql DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
Expand All @@ -94,7 +102,9 @@ Run aiomysql test suite
-----------------------

After all the preconditions are met you can run tests typing the next
command::
command:

.. code-block:: sh

$ make test

Expand All @@ -113,7 +123,9 @@ Tests coverage

We are trying hard to have good test coverage; please don't make it worse.

Use::
Use:

.. code-block:: sh

$ make cov

Expand All @@ -130,7 +142,9 @@ Documentation

We encourage documentation improvements.

Please before making a Pull Request about documentation changes run::
Please before making a Pull Request about documentation changes run:

.. code-block:: sh

$ make doc

Expand Down