Improve documentation with errors and links #642
Merged
Conversation
This file contains hidden or 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
I added several links to the PEP 249 documentation. I also documented the various exceptions that can be raised and, clarified the meaning of some parameters. Overall, readers will be able to cross-reference methods with the specification, and will see implementation-specific info. This will make it clear that this library implements the full specification, which is important because there is almost no direct documentation of this library.
|
Note: Build errors don't seem to be related to my code. |
|
Thanks. |
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 added several links to the PEP 249 documentation. I also documented
the various exceptions that can be raised and, clarified the meaning
of some parameters.
Overall, readers will be able to cross-reference methods with the
specification, and will see implementation-specific info. This will
make it clear that this library implements the full specification,
which is important because there is almost no direct documentation
of this library.
I've confirmed that the docs build correctly using the makefile in
docs/.Let me know if I missed anything, or if there are any style issues.