Avoid misleading attribute-reference in iiasa.Connection docstring #800
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.
Description of PR
Per an observation by @Rlamboll, the current docstring of the iiasa.Connection class is misleading because it states
when a user actually has to do
pyam.iiasa.Connection().valid_connections
.This PR changes the docstring to only show the attribute-name in the docstring (instead of
pyam.iiasa...
) while maintaining a functioning link to the docs of that attribute.