From 8ce0c26c4b0706dcc4624f5fd1f36bd4114fcba6 Mon Sep 17 00:00:00 2001 From: Meg Schwamb Date: Sun, 31 Dec 2023 14:01:58 +0000 Subject: [PATCH] update readme update readme with standard for docstrings --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ddc80cc3..70df1a9a 100644 --- a/README.md +++ b/README.md @@ -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,