Skip to content

Meet PyOpenSci baseline requirements #75

@amyheather

Description

@amyheather

Although not planning to submit to PyOpenSci, would be good to meet their baseline requirements - those outstanding are:

  • "API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format." - though everything is documented, at present, no easy way for users to browse from site, they have to go into code itself, so would be good to add to the documentation website.
  • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
  • Code of Conduct The package has a CODE_OF_CONDUCT.md file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions