Documentation cleanup and clarification #689
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Kudos, SonarCloud Quality Gate passed!
|
|
@camtarn Thanks for the PR, there has been some discussions around using python type annotations for pymodbus3.x. I am not sure of the timelines for that, but I can include these for the time being. |
Expose base response classes to allow doc gen Not having these base classes in the docs meant that the most important documentation (i.e. how to retrieve response items from the response) was undocumented. If exposing them as public module classes is undesired, some Sphinx directives could instead be used to cause Sphinx to document them. Add newlines to docstrings to stop docs breaking Remove automodule statement which didn\'t do anything The module name is async_io, not asyncio 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.
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was having issues with the pymodbus documentation as a new user. I've tried to fix some of the issues I was running up against:
The approach I have taken is obviously up for debate (especially exposing the base classes in
__all__) but I wanted to get the ball rolling with some code :)