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

Re-evaluate default docstrings #162

Open
jpfeuffer opened this issue Aug 21, 2022 · 1 comment
Open

Re-evaluate default docstrings #162

jpfeuffer opened this issue Aug 21, 2022 · 1 comment

Comments

@jpfeuffer
Copy link
Contributor

Currently, we do:

  Cython implementation: ...
  Cython implementation: ...

  Documentation can be found here: $URL$

  $Additional wrap-doc$

First: I think autodoc-docstring-signatures would be much more helpful than the Cython implementations. We have the code to generate the signatures already from the typestub support.

Second: We should use Markdown or RST to not spell out the whole URL.

Third: A link to the actual PXD, based on a parameterizable root URL would be nice.

Fourth: Sometimes indentation and newlines after the default docstring and the additional wrap-docs is missing.

@jpfeuffer
Copy link
Contributor Author

First has been implemented in #166
Second had to be and has been implement in OpenMS directly.
I think Fourth is also solved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant