Yasuke/moto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Small documentation improvements for new developers (#6895)

Browse Source
This commit is contained in:
Pepijn 2023-10-09 21:09:49 +02:00 committed by GitHub
parent 34bc540f70
commit b2455e4211
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/contributing/development_tips/tests.rst
View File

@ -33,7 +33,7 @@ To verify whether your tests pass in ServerMode, you can run the following comma
.. sourcecode:: bash .. sourcecode:: bash
moto_server python moto/server.py
TEST_SERVER_MODE=true pytest -sv tests/test_service/.. TEST_SERVER_MODE=true pytest -sv tests/test_service/..

16
docs/docs/contributing/installation.rst
View File

@ -36,13 +36,20 @@ With all dependencies installed, run the following command to run all the tests
Note that this may take awhile - there are many services, and each service will have a boatload of tests. Note that this may take awhile - there are many services, and each service will have a boatload of tests.
You can also run the linting checks separately:
.. code-block:: bash
make lint
To verify all tests pass for a specific service, for example for `s3`, run these commands manually: To verify all tests pass for a specific service, for example for `s3`, run these commands manually:
.. code-block:: bash .. code-block:: bash
ruff moto/s3 ruff moto/s3 tests/test_s3
black --check moto/s3 tests/test_s3 black --check moto/s3 tests/test_s3
pylint tests/test_s3 pylint moto/s3 tests/test_s3
mypy
pytest -sv tests/test_s3 pytest -sv tests/test_s3
If black fails, you can run the following command to automatically format the offending files: If black fails, you can run the following command to automatically format the offending files:
@ -76,7 +83,8 @@ Then standard development on Moto can proceed, for example:
.. code-block:: bash .. code-block:: bash
ruff moto/s3 ruff moto/s3 tests/test_s3
black --check moto/s3 tests/test_s3 black --check moto/s3 tests/test_s3
pylint tests/test_s3 pylint moto/s3 tests/test_s3
mypy
pytest -sv tests/test_s3 pytest -sv tests/test_s3