Skip to content

Commit

Permalink
Remove docstring implementation suggestion from checks
Browse files Browse the repository at this point in the history
  • Loading branch information
dstansby authored and lwasser committed May 26, 2023
1 parent 46632a5 commit 9ae9d83
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion appendices/editor-in-chief-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ below.
- [ ] **Documentation** The package has sufficient online documentation to allow us to evaluate package function and scope *without installing the package*. This includes:
- [ ] User-facing documentation that overviews how to install and start using the package.
- [ ] Short tutorials that help a user understand how to use the package and what it can do for them.
- [ ] 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. *We suggest using the [Numpy](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) docstring format*.
- [ ] 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.
- [ ] Core GitHub repository Files
- [ ] **README** The package has a `README.md` file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
- [ ] **Contributing File** The package has a `CONTRIBUTING.md` file that details how to install and contribute to the package.
Expand Down

0 comments on commit 9ae9d83

Please sign in to comment.