Skip to content

Commit 1f24285

Browse files
Fix doc links and remarks (#144)
* Update index.rst * Update features.rst * Update tutorial.rst * Update contributing.rst * Update index.rst * Update CONTRIBUTING.rst
1 parent 87a4922 commit 1f24285

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

CONTRIBUTING.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Setting up your development environment
3737

3838
.. code-block:: text
3939
40-
git remote add fork https://github.com/{username}/pytest-flask
40+
$ git remote add fork https://github.com/{username}/pytest-flask
4141
4242
- Using `Tox`_, create a virtual environment and install pytest-flask in editable mode with development dependencies.
4343

@@ -53,7 +53,7 @@ Setting up your development environment
5353
$ pre-commit install
5454
5555
.. _Fork: https://github.com/pytest-dev/pytest-flask/fork
56-
.. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
56+
.. _Clone: https://docs.github.com/en/get-started/quickstart/fork-a-repo#step-2-create-a-local-clone-of-your-fork
5757
.. _Tox: https://tox.readthedocs.io/en/latest/
5858

5959
Start Coding
@@ -76,7 +76,7 @@ Start Coding
7676
7777
$ git push --set-upstream fork your-branch-name
7878
79-
.. _create a pull request: https://help.github.com/en/articles/creating-a-pull-request
79+
.. _create a pull request: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
8080

8181
How to run tests
8282
~~~~~~~~~~~~~~~~

docs/contributing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Setting up your development environment
3939

4040
.. code-block:: text
4141
42-
git remote add fork https://github.com/{username}/pytest-flask
42+
$ git remote add fork https://github.com/{username}/pytest-flask
4343
4444
- Using `Tox`_, create a virtual environment and install pytest-flask in editable mode with development dependencies.
4545

@@ -55,7 +55,7 @@ Setting up your development environment
5555
$ pre-commit install
5656
5757
.. _Fork: https://github.com/pytest-dev/pytest-flask/fork
58-
.. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
58+
.. _Clone: https://docs.github.com/en/get-started/quickstart/fork-a-repo#step-2-create-a-local-clone-of-your-fork
5959
.. _Tox: https://tox.readthedocs.io/en/latest/
6060

6161
Start Coding
@@ -78,7 +78,7 @@ Start Coding
7878
7979
$ git push --set-upstream fork your-branch-name
8080
81-
.. _create a pull request: https://help.github.com/en/articles/creating-a-pull-request
81+
.. _create a pull request: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
8282

8383
How to run tests
8484
~~~~~~~~~~~~~~~~
@@ -110,4 +110,4 @@ test suite run ``pytest`` using ``coverage``.
110110
111111
Open ``htmlcov/index.html`` in your browser.
112112

113-
More about converage `here <https://coverage.readthedocs.io>`__.
113+
More about coverage `here <https://coverage.readthedocs.io>`__.

docs/features.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -378,13 +378,13 @@ on `what markers are`_ and for notes on `using them`_.
378378
assert not app.debug, 'Ensure the app is not in debug mode'
379379
380380
381-
.. _pytest-xdist: https://pypi.python.org/pypi/pytest-xdist
381+
.. _pytest-xdist: https://pypi.org/project/pytest-xdist/
382382
.. _pytest documentation: https://pytest.org/en/latest/fixture.html
383-
.. _flask.Flask.test_client: https://flask.palletsprojects.com/en/1.1.x/api/#flask.Flask.test_client
384-
.. _flask.Config: https://flask.palletsprojects.com/en/1.1.x/api/#flask.Config
383+
.. _flask.Flask.test_client: https://flask.palletsprojects.com/api/#flask.Flask.test_client
384+
.. _flask.Config: https://flask.palletsprojects.com/api/#flask.Config
385385
.. _Selenium: https://selenium-python.readthedocs.io/
386386
.. _what markers are: https://pytest.org/en/latest/mark.html
387387
.. _using them: https://pytest.org/en/latest/example/markers.html#marking-whole-classes-or-modules
388-
.. _Flask API: https://flask.palletsprojects.com/en/1.1.x/api/#flask.Flask.test_client
389-
.. _Werkzeug test client: https://werkzeug.palletsprojects.com/en/1.0.x/test/#werkzeug.test.Client
390-
.. _blueprint: https://flask.palletsprojects.com/en/1.1.x/blueprints/
388+
.. _Flask API: https://flask.palletsprojects.com/api/
389+
.. _Werkzeug test client: https://werkzeug.palletsprojects.com/test/#werkzeug.test.Client
390+
.. _blueprint: https://flask.palletsprojects.com/blueprints/

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Welcome to pytest-flask’s documentation!
22
========================================
33

4-
Pytest-flask is a plugin for `pytest <http://pytest.org>`_ that provides
5-
a set of useful tools to test `Flask <http://flask.pocoo.org>`_ applications
4+
Pytest-flask is a plugin for `pytest <https://pytest.org/en/latest/>`_ that provides
5+
a set of useful tools to test `Flask <https://flask.palletsprojects.com/>`_ applications
66
and extensions.
77

88

docs/tutorial.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ What’s next?
4949
The :ref:`features` section gives a more detailed view of available features, as
5050
well as test fixtures and markers.
5151

52-
Consult the `pytest documentation <http://pytest.org/latest>`_ for more
52+
Consult the `pytest documentation <https://pytest.org/en/latest>`_ for more
5353
information about pytest itself.
5454

5555
If you want to contribute to the project, see the :ref:`contributing` section.
5656

5757

58-
.. _PyPi: https://pypi.python.org/pypi/pytest-flask
58+
.. _PyPi: https://pypi.org/project/pytest-flask/
5959
.. _discovers your tests: http://docs.pytest.org/en/latest/goodpractices.html#test-discovery
6060
.. _official documentation: http://pytest.org/latest/usage.html

0 commit comments

Comments
 (0)