From 417fcfb1172857b9e911b28ca915073e7f457087 Mon Sep 17 00:00:00 2001 From: James Budarz Date: Wed, 29 Mar 2023 10:03:24 -0400 Subject: [PATCH 1/2] Add numpydoc docstring standard to contribution guide --- docs/internals/contributing.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/internals/contributing.md b/docs/internals/contributing.md index d528e7f8..8fa6c93b 100644 --- a/docs/internals/contributing.md +++ b/docs/internals/contributing.md @@ -20,6 +20,12 @@ We will do our best to respond to and review your PR and we hope you will stay e We'd appreciate [issue reports](https://github.com/Netflix/metaflow/issues) if you run into trouble using Metaflow. +#### Code Style + +We use [black](https://black.readthedocs.io/en/stable/) as a code formatter. The easiest way to ensure your commits are always formatted with the correct version of `black` it is to use [pre-commit](https://pre-commit.com/): install it and then run `pre-commit install` once in your local copy of the repo. + +We also follow the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) docstring style to enable automatic documentation using [Sphinx](https://www.sphinx-doc.org/en/master/). + ### Community Everyone is welcome to join us in our [chatroom](http://chat.metaflow.org/)! From 1ae52df1f362e3a6ebd05b63fb8f69ebf65b1b27 Mon Sep 17 00:00:00 2001 From: James Budarz Date: Wed, 29 Mar 2023 11:46:10 -0400 Subject: [PATCH 2/2] Change Sphinx reference to nbdoc --- docs/internals/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internals/contributing.md b/docs/internals/contributing.md index 8fa6c93b..d4345049 100644 --- a/docs/internals/contributing.md +++ b/docs/internals/contributing.md @@ -24,7 +24,7 @@ We'd appreciate [issue reports](https://github.com/Netflix/metaflow/issues) if y We use [black](https://black.readthedocs.io/en/stable/) as a code formatter. The easiest way to ensure your commits are always formatted with the correct version of `black` it is to use [pre-commit](https://pre-commit.com/): install it and then run `pre-commit install` once in your local copy of the repo. -We also follow the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) docstring style to enable automatic documentation using [Sphinx](https://www.sphinx-doc.org/en/master/). +We also follow the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) docstring style to enable automatic documentation using [nbdoc](https://github.com/outerbounds/nbdoc). ### Community