New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doxygen for pydrake? #7915

Closed
RussTedrake opened this Issue Jan 31, 2018 · 3 comments

Comments

Projects
None yet
3 participants
@RussTedrake
Contributor

RussTedrake commented Jan 31, 2018

My current workflow for writing code in pydrake is a bit cumbersome... I normally read the API in the c++ doxygen, then have the pybind code open to see what pieces of the API are currently wrapped (and how). What do we want this to look like in the future? Should we generate a separate doxygen page for pydrake? Should we be trying to make the docstring workflow the preferred approach?

\cc @EricCousineau-TRI

@RussTedrake RussTedrake self-assigned this Jan 31, 2018

@jwnimmer-tri

This comment has been minimized.

Show comment
Hide comment
@jwnimmer-tri

jwnimmer-tri Jan 31, 2018

Collaborator

See also #7914.

Collaborator

jwnimmer-tri commented Jan 31, 2018

See also #7914.

@EricCousineau-TRI

This comment has been minimized.

Show comment
Hide comment
@EricCousineau-TRI

EricCousineau-TRI Jan 31, 2018

Contributor

For the short term, can I ask what environment you are using? Are you using an environment in which autocomplete is available?

One thing I haven't investigated is what pybind11s overloads look like in Python docstrings - my guess is that they've thought it through, but I have not yet investigated it.

Would you like me to prioritize this? (It would take a few days of focused time, either for manual porting (which I do not prefer, but would be a starting point) or the route of automation (to stabilize / minimize duplication).)

That being said, would it be OK if we consolidate discussion to #7914 or this issue?

Contributor

EricCousineau-TRI commented Jan 31, 2018

For the short term, can I ask what environment you are using? Are you using an environment in which autocomplete is available?

One thing I haven't investigated is what pybind11s overloads look like in Python docstrings - my guess is that they've thought it through, but I have not yet investigated it.

Would you like me to prioritize this? (It would take a few days of focused time, either for manual porting (which I do not prefer, but would be a starting point) or the route of automation (to stabilize / minimize duplication).)

That being said, would it be OK if we consolidate discussion to #7914 or this issue?

@RussTedrake

This comment has been minimized.

Show comment
Hide comment
@RussTedrake

RussTedrake Jan 31, 2018

Contributor

Closing in favor of #7914.

Contributor

RussTedrake commented Jan 31, 2018

Closing in favor of #7914.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment