Document and resolve LibValueType
#836
Merged
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.
Rationale
BaseLiballows nested collection types (list,tupleanddict. Because of this, the type aliasLibValueTypehas to use forward references as strings:Sphinx, in turn, will not resolve correctly in the generated documentation.
Solution
LibValueclass tobase.annotationspurely for the purpose of documenting these types.autodoc_type_aliasesinconf.pyLibValueclass inobjectref/valuetypes/index.rst.Alternate Name
BaseLibValuemight be a more appropriate name for this class.