You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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).
Copy file name to clipboardexpand all lines: README.md
-5
Original file line number
Diff line number
Diff line change
@@ -48,8 +48,3 @@ There are several ways to get in touch with us:
48
48
## Contributing
49
49
50
50
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.
0 commit comments