[DOC] avoid C++ types in docstrings#2441
Conversation
42c8829 to
b6354ba
Compare
a6abf2c to
a22833d
Compare
YannickJadoul
left a comment
There was a problem hiding this comment.
A few things I would personally phrase slightly differently (up to you to decide if you like it better or not), but looks succinct and good to me!
misc.rst seems find. I don't immediately see another place where we talk about docstrings and signature. It's right underneath the only other section about it ("Generating documentation using Sphinx"), so perfect for me!
Thanks for taking the time to create this, @sizmailov! :-)
|
Great, thanks! Let's see if someone else still has something to add. If not, this can go in as-is, afaic :-) |
bstaletic
left a comment
There was a problem hiding this comment.
@sizmailov Thanks for the PR
|
Thanks everybody for quick and thoughtful reviews with great attention to even subtle things! |
|
More like, thanks @sizmailov for making this PR and fixing all our minor remarks ;-) Thanks a lot! |
|
How to solve this if EDIT: solved it, |
Here is a small paragraph about docstring generation in pybind11. Also replicates @YannickJadoul 's example from #2263.
I'm not sure if
misc.rstis the best place for it.render