Skip to content

Clean up modules #1566

@akern40

Description

@akern40

ndarray has a lot of modules! They tend to be a little hard to read through, and it can be hard to know where code should go when adding or modifying the library. I'd like for us to refactor our codebase to follow a few principles for module definition:

  1. Always have module-level documentation, even for private modules. By telling readers what a module aims to do, we can help contributors know where to add/remove/change code.
  2. Reduce or eliminate most module-level code, opting for just mod ... and ... use ... declarations. This should make it really fast for contributors to figure out how a module is structured.

This is especially important for public modules, but preferably should be applied to private modules, as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsIssues relating primarily to documentation or API visibility.good first issueA good issue to start contributing to ndarray!tracking-issueIssue to track multiple changes or collect information.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions