PR: Transform function and method signatures to rst#352
PR: Transform function and method signatures to rst#352asmeurer merged 2 commits intodata-apis:mainfrom
Conversation
|
|
||
| Parameters | ||
| funcname(x1, x2, /, *, key1=-1, key2=None) -> out: | ||
| Parameters |
There was a problem hiding this comment.
What is the purpose of this code block? Is it supposed to be to show an example of what the documentation in the spec looks like? If so, can we put this dummy function in the code and pull it in with autodoc? Though I honestly don't understand the point of having it at all if that's why it's there. If it's supposed to be to show what a valid function signature looks like, why not make this fully valid Python?
There was a problem hiding this comment.
I think is just to explain how function and method signatures are in the spec, this is the current example that is in the spec. What do you think about this @kgryte?
There was a problem hiding this comment.
Since this is already there, we can merge this without addressing it. But I do find this a bit confusing.
3 participants
This PR converts the function and method signatures markdown into rst
Ref: #283