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.

Sign up for GitHub

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

Jump to bottom

Incomplete documentation for properties #69

Closed
VVelda opened this issue Oct 23, 2019 · 1 comment · Fixed by #106
Closed

Incomplete documentation for properties #69

VVelda opened this issue Oct 23, 2019 · 1 comment · Fixed by #106
Assignees
@orbeckst
Labels
documentation

Comments

@VVelda
Copy link

VVelda commented Oct 23, 2019

In the documentation is not mentioned there exists properties origin and delta and existence of grid is mentioned only sort of accidentally.

I suggest to properly add information about public properties of the main object.
@orbeckst
Copy link
Member

I started adding this information for the new MRC class in PR #100 and this can be used as a template for the other classes where it is missing.

@orbeckst orbeckst self-assigned this Feb 20, 2022
orbeckst added a commit that referenced this issue Feb 20, 2022
@orbeckst
improved docs for core.Grid
feed698 
- fix #69
- document all public attributes
- various text/syntax fixes
- fixed docs for MRC
- added forgotten import of `mrc` to core/__init__.py
- update CHANGELOG
@orbeckst orbeckst mentioned this issue Feb 20, 2022
Merged
orbeckst added a commit that referenced this issue Feb 21, 2022
@orbeckst
improved docs for core.Grid (#106)
eba0d8e 
* fix #69
* improved docs for core.Grid
  - document all public attributes (grid, edges, delta, origin, midpoints)
  - document raised exceptions
  - various text/syntax fixes
* fixed docs for MRC
* removed pretty superfluous categories from title doc page
* added forgotten import of `mrc` to core/__init__.py
* update CHANGELOG
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orbeckst orbeckst

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

improved docs for core.Grid MDAnalysis/GridDataFormats
2 participants
@orbeckst @VVelda