From 8d48224068eccd5258cad218618cd594bd0238a1 Mon Sep 17 00:00:00 2001 From: Wenqi Li Date: Wed, 26 Jul 2023 11:38:58 +0100 Subject: [PATCH] update docstring format guide Signed-off-by: Wenqi Li --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d97cabc2cb..c37ce2d425 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,6 +151,10 @@ make html ``` The above commands build html documentation, they are used to automatically generate [https://docs.monai.io](https://docs.monai.io). +The Python code docstring are written in +[reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) and +the documentation pages can be in either [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) or [Markdown](https://en.wikipedia.org/wiki/Markdown). In general the Python docstrings follow the [Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). + Before submitting a pull request, it is recommended to: - edit the relevant `.rst` files in [`docs/source`](./docs/source) accordingly. - build html documentation locally