Skip to content

Commit 5b62de8

Browse files
committed
Enhance docs typography, e.g. s/'/’/
Replace non-curly apostrophes (') with the curly version (’). As per http://practicaltypography.com/apostrophes.html.
1 parent a19db4a commit 5b62de8

File tree

7 files changed

+15
-13
lines changed

7 files changed

+15
-13
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Install the extension with dependencies and go::
3131
Contributing
3232
------------
3333

34-
Don't hesitate to create a `GitHub issue <https://github.com/vitalk/pytest-flask/issues>`__ for any bug or
34+
Dont hesitate to create a `GitHub issue <https://github.com/vitalk/pytest-flask/issues>`__ for any bug or
3535
suggestion.
3636

3737
.. |PyPI version| image:: https://img.shields.io/pypi/v/pytest-flask.svg

docs/changelog.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Changelog
66
Upcoming release
77
-----------------
88

9+
- Minor typography improvements in documentation.
10+
911
- Add changelog to documentation.
1012

1113
0.10.0 (compared to 0.9.0)
@@ -84,7 +86,7 @@ Upcoming release
8486
-----
8587

8688
- Bind live server to a random port instead of 5000 or whatever is passed on
87-
the command line, so it's possible to execute tests in parallel via
89+
the command line, so its possible to execute tests in parallel via
8890
pytest-dev/pytest-xdist (#15). Thanks to @davehunt.
8991

9092
- Remove ``--liveserver-port`` option.

docs/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ well.
2020
Where are the tests?
2121
--------------------
2222

23-
Good that you're asking. The repository test suite is located in ``tests``
23+
Good that youre asking. The repository test suite is located in ``tests``
2424
directory. Makefile defines a target to run them::
2525

2626
make test

docs/features.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ other headless browsers).
124124

125125
.. hint::
126126

127-
The server's URL can be retrieved using the ``url_for`` function.
127+
The servers URL can be retrieved using the ``url_for`` function.
128128

129129
.. code:: python
130130
@@ -143,14 +143,14 @@ other headless browsers).
143143
```````````````````````````````````````````````````````````````````
144144

145145

146-
``--no-start-live-server`` - don't start live server automatically
146+
``--no-start-live-server`` - dont start live server automatically
147147
``````````````````````````````````````````````````````````````````
148148

149149
By default the server is starting automatically whenever you reference
150150
``live_server`` fixture in your tests. But starting live server imposes some
151151
high costs on tests that need it when they may not be ready yet. To prevent
152152
that behaviour pass ``--no-start-live-server`` into your default options (for
153-
example, in your project's ``pytest.ini`` file)::
153+
example, in your projects ``pytest.ini`` file)::
154154

155155
[pytest]
156156
addopts = --no-start-live-server
@@ -182,7 +182,7 @@ The request context which contains all request relevant information.
182182
.. hint::
183183

184184
The request context has been pushed implicitly any time the ``app``
185-
fixture is applied and is kept around during test execution, so it's easy
185+
fixture is applied and is kept around during test execution, so its easy
186186
to introspect the data:
187187

188188
.. code:: python

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Welcome to pytest-flask's documentation!
1+
Welcome to pytest-flasks documentation!
22
========================================
33

44
Pytest-flask is a plugin for `pytest <http://pytest.org>`_ that provides
55
a set of useful tools to test `Flask <http://flask.pocoo.org>`_ applications
66
and extensions.
77

88

9-
User's Guide
9+
Users Guide
1010
------------
1111

1212
This part of the documentation will show you how to get started in using
@@ -47,6 +47,6 @@ And run your test suite::
4747
Contributing
4848
------------
4949

50-
Don't hesitate to create a `GitHub issue
50+
Dont hesitate to create a `GitHub issue
5151
<https://github.com/vitalk/pytest-flask/issues>`_ for any **bug** or
5252
**suggestion**.

docs/tutorial.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Use the ``py.test`` command to run your test suite::
4343
documentation`_.
4444

4545

46-
What's next?
46+
Whats next?
4747
------------
4848

4949
The :ref:`features` section gives a more detailed view of available features, as

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def test_api_ping(client):
5252
assert res.json == {'ping': 'pong'}
5353
5454
If you want your tests done via Selenium or other headless browser use
55-
the ``live_server`` fixture. The server's URL can be retrieved using
55+
the ``live_server`` fixture. The servers URL can be retrieved using
5656
the ``url_for`` function:
5757
5858
.. code:: python
@@ -97,7 +97,7 @@ def app():
9797
Contributing
9898
------------
9999
100-
Don't hesitate to create a `GitHub issue
100+
Dont hesitate to create a `GitHub issue
101101
<https://github.com/vitalk/pytest-flask/issues>`_ for any **bug** or
102102
**suggestion**.
103103

0 commit comments

Comments
 (0)