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

Docstring and documentation improvement for the Dataset class #8973

Merged
merged 8 commits into from
Apr 30, 2024

Commits on Apr 25, 2024

  1. Updates the example in the doc-string for the Dataset class to be cle…

    …arer.
    
    The example in the doc-string of the `Dataset` class prior to this commit
    uses an example array whose size is `2 x 2 x 3` with the first two dimensions
    labeled `"x"` and `"y"` and the final dimension labeled `"time"`. This was
    confusing due to the fact that `"x"` and `"y"` are just arbitrary names for
    these axes and that no reason is given for the data to be organized in a `2x2x3`
    array instead of a `2x2` matrix. This commit clarifies the example.
    
    See issue pydata#8970 for more information.
    noahbenson committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    ce6b158 View commit details
    Browse the repository at this point in the history
  2. Updates the documentation of the Dataset class to have clearer examples.

    These changes to the documentation bring it into alignment with the
    changes to the `Dataset` doc-string committed previously.
    
    See issue pydata#8970 for more information.
    noahbenson committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    2b72c96 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    6454852 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    2280ba4 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    2a03e91 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    dfb308a View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    1ca80ba View commit details
    Browse the repository at this point in the history

Commits on Apr 29, 2024

  1. Configuration menu
    Copy the full SHA
    b92c52d View commit details
    Browse the repository at this point in the history