Copy docstrings for forwarded methods in MDF #1213
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Viewing the docstring/help is currently not possible for methods in MDF that are originally implemented in MDF3 and/or MDF4, for example
get.I think this is an unintended side effect of the recent and excellent type safety work by @JulienGrv.
getand some other methods are explicitly redefined in the MDF class and just forwarding the value from their equivalents in the_mdfobject, and from reading this discussion I understand why it was done. What is missing is just the connection to the docstring of the underlying method, from either MDF3 or MDF4.In this PR I solve it by copying
__doc__fromMDF._mdf.method_nametoMDF.method_namein__init__. It works but there might be some other issue I have overlooked.