We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Copied from numpy/numpy#421.
When documenting at the same time properties and normal attributes, nothing is rendered at all.
e.g. in the example below:
class ExampleClass1 """ Attributes ---------- prop1 attr2 : string Some string attribute. """ @property def prop1(self) """ Property 1 docsting """ pass
The docstring is transformed in the following reST (docscrape_sphinx.py:57,strmember_list) :
.. rubric:: Attributes .. autosummary:: :toctree: prop1 ============== ================ ========== attr2 string Some string attribute ============== ================ ==========
but this is not correct as a newline is missing after "prop1":
The text was updated successfully, but these errors were encountered:
Affects me too. So, is adding a \n after prop1 confirmed to fix it? If so who wants to patch the code?
Sorry, something went wrong.
I think this must have been previously fixed and has been changed again in #106. It is tested in https://github.com/numpy/numpydoc/blob/f09abc8/numpydoc/tests/test_docscrape.py#L898 rendering as https://github.com/numpy/numpydoc/blob/f09abc8/numpydoc/tests/test_docscrape.py#L1028.
This should be closed.
I'm closing
No branches or pull requests
Copied from numpy/numpy#421.
When documenting at the same time properties and normal attributes, nothing is rendered at all.
e.g. in the example below:
The docstring is transformed in the following reST (docscrape_sphinx.py:57,strmember_list) :
but this is not correct as a newline is missing after "prop1":
The text was updated successfully, but these errors were encountered: