Skip to content
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

docstring of #[new] methods are not shown in API document #267

Open
mh-northlander opened this issue Jul 4, 2024 · 1 comment · May be fixed by #268
Open

docstring of #[new] methods are not shown in API document #267

mh-northlander opened this issue Jul 4, 2024 · 1 comment · May be fixed by #268
Labels
documentation Improvements or additions to documentation python Python binding-related

Comments

@mh-northlander
Copy link
Collaborator

mh-northlander commented Jul 4, 2024

We have comments in the code but API document page lacks them.

maybe relating to PyO3: defining class constructor

@mh-northlander mh-northlander added documentation Improvements or additions to documentation python Python binding-related labels Jul 4, 2024
@mh-northlander
Copy link
Collaborator Author

It seems this is an open issue: PyO3/pyo3#553

I think for now we can move docstring for the constructors to that for the classes (with this we can at least see documents for constructors).

@mh-northlander mh-northlander linked a pull request Jul 8, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Python binding-related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant