Skip to content

Commit 119afac

Browse files
Add docstring style to contribution code style guide (Netflix#1328)
* Add docstring style to contribution code style guide * Move code style guide from README to CONTRIBUTING.md * Replace link to Sphinx with nbdoc * Trigger Build
1 parent b1d120b commit 119afac

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,9 @@ Everyone is welcome to join us in our [chatroom](http://chat.metaflow.org)!
1414
Please maintain appropriate, professional conduct while participating in our community. This includes all channels of
1515
communication. We take reports of harassment or unwelcoming behavior very seriously. To report such behavior, please
1616
contact us via [email](mailto:[email protected]).
17+
18+
### Code style
19+
20+
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.
21+
22+
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).

README.md

-5
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,3 @@ There are several ways to get in touch with us:
4848
## Contributing
4949

5050
We welcome contributions to Metaflow. Please see our [contribution guide](https://docs.metaflow.org/introduction/contributing-to-metaflow) for more details.
51-
52-
### Code style
53-
54-
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.
55-

0 commit comments

Comments
 (0)