Skip to content

Commit 120f800

Browse files
920: Doc comments on new pull requests r=carols10cents Along the lines of rust-lang#899, we should start mandating doc comments on all new types and functions, and encourage doc comments on modified types. Is there a way to check for this in TravisCI as well?
2 parents 81c7ca8 + 9a16101 commit 120f800

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ If you'd like to work on something that isn't in a current issue, especially if
2020
it would be a big change, please open a new issue for discussion!
2121

2222
## Submitting a Pull Request
23+
As an initiative to improve the documentation of the crates.io codebase, we would
24+
like to see all new types and functions, public and private, to have documentation
25+
comments on them. If you change an existing type or function, and it doesn't have
26+
a documentation comment on it, it'd be great if you could add one to it too.
2327

2428
When you submit a pull request, it will be automatically tested on TravisCI. In
2529
addition to running both the frontend and the backend tests described below,

0 commit comments

Comments
 (0)