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

Improvements to documentation on sidpy.Dataset #118

Open
ssomnath opened this issue Apr 16, 2021 · 0 comments
Open

Improvements to documentation on sidpy.Dataset #118

ssomnath opened this issue Apr 16, 2021 · 0 comments
Assignees
@gduscher
Labels
documentation Improvements or additions to documentation

Comments

@ssomnath
Copy link
Member

  • No wget in sidpy examples
  • Naming conventions for metadata field names not clear. Need to state that we are working on a metadata schema but don't have one yet.
  • Demonstrate that you can indeed instantiate a sidpy.Dataset with data, metadata, axes, etc. when constructing the object in one line
  • Doc strings missing for some Dataset functions. Hitting shift + tab in Jupyter did not reveal any docstrings.
@ssomnath ssomnath added the documentation Improvements or additions to documentation label Apr 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gduscher gduscher

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ssomnath @gduscher