Improve make_transform_adapt docstring #234
Draft
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
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.
This PR does two things:
make_transform_adaptto give a basic outline of each parameter (as I understand them), and try to explain situations in which they will not be respected.@wraps(make_transform_adapt)decorator toPyFuncModel.with_transform_adapterto expose this docstring there as well. This is the primary entrypoint to the transform adapt functionality for users, so it's important thathelp(PyFuncModel.with_transform_adapter)gives back something.There are several parameters I marked with ??? because I don't really know what they do. @aseyboldt I'm happy to fill them out if you can give me a thumbnail sketch of what they do