Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
update readme with standard for docstrings
  • Loading branch information
mschwamb committed Dec 31, 2023
1 parent c35601a commit 8ce0c26
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Other software utilities can be found in this github repository: [https://github
* All required input files for the main software or unit tests should have extensions that clearly describe the file format (e.g. .csv, .txt, .db, .fits)
* If you are working on addressing a specific issue ticket, assign yourself the ticket.
* When making a pull request that closes an issue, cite the issue ticket in the pull request summary
* Docstrings should follow the [NumPy style](https://numpydoc.readthedocs.io/en/latest/format.html)

## Collaboration
This effort is a collaboration between Queen's University Belfast, the University of Washington's DiRAC Institute,
Expand Down

0 comments on commit 8ce0c26

Please sign in to comment.