Skip to content

Commit dd7d722

Browse files
committed
Review the whole documentation
1 parent 9688431 commit dd7d722

File tree

6 files changed

+19
-14
lines changed

6 files changed

+19
-14
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ MANIFEST*
1313
.pytest_cache
1414
.tox
1515
.vscode
16+
docs/output/

docs/source/api.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ GNU/Linux
1616

1717
Contains the latest Xlib or XRANDR function.
1818

19+
.. versionadded:: 4.0.0
20+
1921
.. class:: MSS
2022

2123
.. method:: __init__([display=None])
@@ -60,10 +62,10 @@ GNU/Linux
6062

6163
.. method:: grab(monitor)
6264

63-
:rtype: :class:`mss.base.ScreenShot`
65+
:rtype: :class:`~mss.base.ScreenShot`
6466
:raises ScreenShotError: When color depth is not 32 (rare).
6567

66-
See :meth:`mss.base.MSSMixin.grab()` for details.
68+
See :meth:`~mss.base.MSSMixin.grab()` for details.
6769

6870
.. function:: error_handler(display, event)
6971

@@ -76,7 +78,7 @@ GNU/Linux
7678
Error handler passed to `X11.XSetErrorHandler()` to catch any error that can happen when calling a X11 function.
7779
This will prevent Python interpreter crashes.
7880

79-
When such an error happen, a :class:`mss.exception.ScreenShotError` exception is raised and all `XError` information are added to the :attr:`mss.exception.ScreenShotError.details` attribute.
81+
When such an error happen, a :class:`~mss.exception.ScreenShotError` exception is raised and all `XError` information are added to the :attr:`~mss.exception.ScreenShotError.details` attribute.
8082

8183
.. versionadded:: 3.3.0
8284

@@ -106,7 +108,10 @@ Methods
106108

107109
.. method:: close()
108110

109-
Clean-up method. Does nothing by default.
111+
Clean-up method. Does nothing by default. For more information, see specific implementations:
112+
113+
- :meth:`~mss.linux.MSS.close()` for GNU/Linux
114+
- :meth:`~mss.windows.MSS.close()` for Windows
110115

111116
.. versionadded:: 4.0.0
112117

@@ -148,7 +153,7 @@ Methods
148153

149154
IOerror: [Errno 22] invalid mode ('wb') or filename: 'sct_1-2019-01-01 21:20:43.114194.png'
150155

151-
To fix this, you must provide a custom formatting.
156+
To fix this, you must provide a custom date formatting.
152157

153158
.. method:: shot()
154159

@@ -204,7 +209,7 @@ Methods
204209

205210
.. versionadded:: 3.0.0
206211

207-
.. versionadded:: 3.2.0
212+
.. versionchanged:: 3.2.0
208213

209214
The *level* keyword argument to control the PNG compression level.
210215

@@ -331,5 +336,3 @@ Factory
331336
.. function:: mss()
332337

333338
Factory function to instance the appropriate MSS class.
334-
335-
:rtype: :class:`mss.base.MSSMixin`

docs/source/developers.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ How to Test?
3434
Launch the test suit::
3535

3636
$ tox
37-
# TOXENV=py37 tox
37+
38+
# or
39+
$ TOXENV=py37 tox
3840

3941
This will test MSS and ensure a good code quality.
4042

docs/source/support.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Support
44

55
Feel free to try MSS on a system we had not tested, and let report us by creating an `issue <htps://github.com/BoboTiG/python-mss/issues>`_.
66

7-
GNU/Linux, macOS and Windows: **2.7**, 3.5, 3.6 and **3.7**.
7+
- OS: GNU/Linux, macOS and Windows
8+
- Python: 2.7, 3.5, 3.6 and **3.7**
89

910

1011
Future
@@ -29,5 +30,3 @@ Abandoned
2930
- Python 3.2 (2016-10-08)
3031
- Python 3.3 (2017-12-05)
3132
- Python 3.4 (2018-03-19)
32-
33-
By the way, if you find the *force*, give it a try and tell us if you managed to make one of these versions working (a patch should be quite easy).

docs/source/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ So the module can be used as simply as::
3939
sct.grab()
4040
# or any attribute/method of sct
4141

42-
Then you will have to **manually** call :meth:`mss.linux.MSSMixin.close()` to free resources.
42+
Then you will have to **manually** call :meth:`~mss.base.MSSMixin.close()` to free resources.
4343

4444
.. warning::
4545

docs/source/where.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ AI, Computer Vison
2323
Games
2424
=====
2525

26-
- Go Review Partner <https://github.com/pnprog/goreviewpartner>`_, a tool to help analyse and review your game of go (weiqi, baduk) using strong bots;
26+
- `Go Review Partner <https://github.com/pnprog/goreviewpartner>`_, a tool to help analyse and review your game of go (weiqi, baduk) using strong bots;
2727
- `Serpent.AI <https://github.com/SerpentAI/SerpentAI>`_, a Game Agent Framework;
2828

2929
Learning

0 commit comments

Comments
 (0)