From 53beb885dc07d3af598d8b63808758f1e814241a Mon Sep 17 00:00:00 2001 From: "J. George" Date: Fri, 23 Feb 2024 18:10:31 +0100 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9a9dc910..ff5f60fa5 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Contributions are welcome. Please raise a pull request for contributions first. # General guidelines - variable names should be descriptive and should use snake case. -- please use numpy docstrings (use an IDE and switch on thise docstring type; you can check examples in our code base) +- please use numpy docstrings (use an IDE and switch on thise docstring type; you can check examples in our code base; the doctring should be useful for other people) - please write unit tests (testing will be performed with pytest; please look into tests for examples) - please ensure high coverage of the code based on the tests (you can test this with `coverage`)