Skip to content

Improve introductory documentation (idea: NumPy translation table) #9

Description

@grothesque

This project is pretty well documented.
There is complete reference documentation and a document that gives an overview of the code’s design.

What seems still lacking is documentation that helps to get started using mdarray.
As far as I can see this is currently limited to the starting page of the documentation.

I think that an efficient way to plug this gap would be to provide a NumPy-to-mdarray translation table.
It could be similar to https://docs.rs/ndarray/latest/ndarray/doc/ndarray_for_numpy_users/index.html.
NumPy is widely known, so this would be a good way to introduce the library to people without writing an extensive tutorial.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions