Skip to content

Commit 305a3ab

Browse files
authored
Fix link checker make command in CONTRIBUTE.md (#1608)
1 parent 5c69ddf commit 305a3ab

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -252,10 +252,11 @@ Lastly, if the feature really is a game changer or you're very proud of it, cons
252252
make doc
253253
```
254254
* If you're unfamiliar with sphinx, it's a documentation generator which can read comments and docstrings from within the code and generate html documentation.
255-
* If you've added documentation, we also has a command `linkcheck` for making sure all the links correctly go to some destination.
255+
* If you've added documentation, we also have a command `links` for making sure
256+
all the links correctly go to some destination.
256257
This helps tests for dead links or accidental typos.
257258
```bash
258-
make linkcheck
259+
make links
259260
```
260261
* We also use sphinx-gallery which can take python files (such as those in the `examples` folder) and run them, creating html which shows the code and the output it generates.
261262
```bash
@@ -396,7 +397,7 @@ Lastly, if the feature really is a game changer or you're very proud of it, cons
396397
# If you changed documentation:
397398
# This will generate all documentation and check links
398399
make doc
399-
make linkcheck
400+
make links
400401
make examples # mainly needed if you modified some examples
401402
402403
# ... fix any issues

0 commit comments

Comments
 (0)