Skip to content

Commit 46606a1

Browse files
camtarnAndy Walker
authored andcommitted
Add explanatory header text to pymodbus.client
The subpackages TOC tree is large and messy, and the most useful sections (the client common mixin and the synchronous client) are buried well below the fold, with no TOC entries for them.
1 parent 2eee33d commit 46606a1

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/source/library/pymodbus.client.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
pymodbus\.client package
22
========================
33

4+
Pymodbus offers a :mod:`synchronous client <pymodbus.client.sync>`, and async clients based on :mod:`asyncio <pymodbus.client.asynchronous.async_io>`, :mod:`Tornado <pymodbus.client.asynchronous.tornado>`, and :mod:`Twisted <pymodbus.client.asynchronous.Twisted>`.
5+
6+
Each client shares a :mod:`common client mixin <pymodbus.client.common>` which offers simple methods for reading and writing.
47

58
Subpackages
69
-----------

0 commit comments

Comments
 (0)