Skip to content

Commit 6ace7a4

Browse files
SvenDS9ejguan
authored andcommitted
Fix links in CONTRIBUTING.md (#1053)
Summary: Per title Pull Request resolved: #1053 Reviewed By: NivekT Differential Revision: D43622310 Pulled By: ejguan fbshipit-source-id: e1aa3c8f507bec0b5b87c1b4293ae9f6ce277436
1 parent 58c9c7d commit 6ace7a4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ the checks automatically before every `git commit`, you can install them with `p
8686

8787
When adding a new DataPipe, there are few things that need to be done to ensure it is working and documented properly.
8888

89-
1. Naming - please following the naming convention as
90-
[described here](https://github.com/pytorch/data/blob/main/docs/source/tutorial.rst#naming).
89+
1. Naming - please follow the naming convention as
90+
[described here](https://pytorch.org/data/main/dp_tutorial.html#naming).
9191
2. Testing - please add unit tests to ensure that the DataPipe is functioning properly. Here are the
9292
[test requirements](https://github.com/pytorch/data/issues/106) that we have.
9393
- One test that is commonly missed is the serialization test. Please add the new DataPipe to
@@ -98,14 +98,14 @@ When adding a new DataPipe, there are few things that need to be done to ensure
9898
3. Documentation - ensure that the DataPipe has docstring, usage example, and that it is added to the right category of
9999
the right RST file to be rendered.
100100
- If your DataPipe has a functional form (i.e. `@functional_datapipe(...)`), include at the
101-
[end of the first sentence](https://github.com/pytorch/data/blob/main/torchdata/datapipes/iter/util/combining.py#L119)
101+
[end of the first sentence](https://github.com/pytorch/data/blob/main/torchdata/datapipes/iter/util/combining.py#L25)
102102
of your docstring. This will make sure it correctly shows up in the
103103
[summary table](https://pytorch.org/data/main/torchdata.datapipes.iter.html#archive-datapipes) of our
104104
documentation.
105105
4. Import - import the DataPipe in the correct `__init__.py` file.
106106
5. Interface - if the DataPipe has a functional form, make sure that is generated properly by `gen_pyi.py` into the
107107
relevant interface file.
108-
- You can re-generate the pyi files by re-running `python setup.py develop`, then you can examine the new outputs.
108+
- You can re-generate the pyi files by re-running `pip install -e .`, then you can examine the new outputs.
109109

110110
## Contributor License Agreement ("CLA")
111111

0 commit comments

Comments
 (0)