Add documentation and type hints for rdflib.query.Result and rdflib.graph.Graph #1211
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.
Add documentation and type hints for
rdflib.query.Result
. Update documentation and type hints forrdflib.graph.Graph
.I am keen to work on adding documentation and type hints to rdflib.
rdflib.query.Result
'sserialize()
is an example of this work.Please leave any comments on styling and conventions.
Proposed Changes
For the second point, an example would be to remove
rdflib/rdflib/graph.py
Line 1150 in c5ff127
E.g.
Sphinx also understands this and adds hyperlinks automatically as well.
If this is acceptable, we should draft a guideline on adding/updating documentation and type hints to the rdflib codebase.