[DOC] Update functon-container cross-references and fix incorrect types #214
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.
Discussed partially in call with @larsoner & @wmvanvliet.
There is a
See Also
section of the docstrings where connectivity functions link to the connectivity containers they return, and the container classes like to the connectivity functions they are returned from. These references were not present everywhere, and I wanted to make them consistent.However, I found there were existing references where functions were linking to classes they did not return, and classes were linking to functions they were not returned from. There were also cases where the types of container classes returned in connectivity function docstrings were wrong.
There is also an inconsistency where the
Connectivity
class is sometimes used as an indicator of the genericBaseConnectivity
class, and sometimes used to refer to theConnectivity
class specifically. Just thought this could be a potential point of confusion. E.g.Connectivity
is listed as the sole accepted class type inplot_connectivity_circle
when anything inheriting fromBaseConnectivity
is allowed.In this case I didn't change anything because I wasn't sure if others consider it problematic.