pycroscopy / pycroscopy/sidpy

Improvements to documentation on sidpy.Dataset

Open
#118 0 comments 0 reactions 1 assignee View on GitHub

@gduscher is already working on this.

Since Apr 16, 2021.

documentation
Dominant language
Jupyter Notebook
Stars
12
Forks
18
No merged PRs in 30d

Description

  • 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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.