Closed emilykl closed 2 hours ago
Thanks @emilykl for the report!
Agree that these need documenting exhaustively - PR incoming
I'm also hoping we can find a way to not show all the overloads in the docstring https://github.com/mkdocstrings/mkdocstrings/issues/716
Related, I'm not super-proud of from_native
, I think it does too much, and think we can design something better for when we get to stable.v2
What type of report is this?
Improvement
Please describe the issue.
While consulting the docs today I noticed that the behavior of the boolean arguments to
from_native()
is not fully explained, particularly sinceNone
is one of the allowed values, and most of the arguments default toNone
, so it's unclear what is the default behavior./The explanation for
pass_through
is nearly there, since it clearly explains the behavior in theTrue
andFalse
cases, but it doesn't explain the behavior in theNone
case. (I notice that the explanation says thatTrue
is the default even though the value listed under the "Default" column isNone
-- maybe the values in the "Default" column are just incorrect?)If you have a suggestion on how it should be, add it below.
For each boolean argument, docs should explain:
True
False
None
Screenshot of relevant portion of docs