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

.axes not in documentation #301

Closed
gdementen opened this issue Jun 7, 2017 · 5 comments
Closed

.axes not in documentation #301

gdementen opened this issue Jun 7, 2017 · 5 comments
Assignees
Milestone

Comments

@gdementen
Copy link
Contributor

No description provided.

@gdementen
Copy link
Contributor Author

In fact it is, but only in LArray.__init__ while users understandably looked for it in the "inspecting" section. Unsure whether fixing #302 would change anything in this regard.

@alixdamman
Copy link
Collaborator

documenting class instance attribute is not implemented in current Sphinx (1.5.1).

sphinx-doc/sphinx#3257

@alixdamman
Copy link
Collaborator

One way would be to implement a property axes

@gdementen
Copy link
Contributor Author

I do not like changing the code/functionality just for the documentation, so I would do this as a last resort (we would need a property for .data too) and either change the code to use ._data and ._axes (the real fields behind the property) everywhere (ugly and not fun to change) or incur a performance penalty.
From the linked issue I get we cannot have this automatically (using autosummary), but can't we do this manually (ie add the documentation directly in api.rst)?

@alixdamman
Copy link
Collaborator

Well, I had the same thought about creating a property. I wanted to include the entries for axes and data in the table generated by the command autosummary. I'll explore what would be the best solution.

alixdamman added a commit to alixdamman/larray that referenced this issue Jun 12, 2017
alixdamman added a commit to alixdamman/larray that referenced this issue Jun 13, 2017
@gdementen gdementen modified the milestone: 0.24 Jun 14, 2017
gdementen pushed a commit that referenced this issue Aug 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants