Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add lint when no doc is present at the crate-level #66938

Merged
merged 6 commits into from
Mar 28, 2020

Conversation

GuillaumeGomez
Copy link
Member

Follow-up of #66267.

r? @kinnison

Copy link
Contributor

@jonas-schievink jonas-schievink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the motivation for this is given that we already have a missing docs lint

src/librustdoc/core.rs Outdated Show resolved Hide resolved
src/librustdoc/core.rs Outdated Show resolved Hide resolved
@Centril Centril added I-nominated T-lang Relevant to the language team, which will review and decide on the PR/issue. and removed I-nominated T-lang Relevant to the language team, which will review and decide on the PR/issue. labels Dec 1, 2019
src/librustdoc/core.rs Outdated Show resolved Hide resolved
@GuillaumeGomez
Copy link
Member Author

@jonas-schievink I'd like to have this lint activated at the warning level by default once we all agree on it (and once the rustdoc book page is stable too). The idea is to provide some help by default for people that don't know how to write documentation.

Hmmm... Maybe I should have written that in the PR description...

@jonas-schievink jonas-schievink added T-lang Relevant to the language team, which will review and decide on the PR/issue. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 2, 2019
Copy link
Contributor

@kinnison kinnison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of potential wording tweaks in addition to the other comments.

src/librustdoc/core.rs Outdated Show resolved Hide resolved
src/librustdoc/core.rs Outdated Show resolved Hide resolved
@kinnison kinnison added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 5, 2019
@bors
Copy link
Contributor

bors commented Dec 23, 2019

☔ The latest upstream changes (presumably #67540) made this pull request unmergeable. Please resolve the merge conflicts.

@joelpalmer
Copy link

Ping from Triage: any updates @GuillaumeGomez?

@GuillaumeGomez
Copy link
Member Author

I need to update the PR. Lack of time lately...

@JohnTitor
Copy link
Member

Ping from triage: @GuillaumeGomez any updates on this? This PR is idle for about two months.

@GuillaumeGomez
Copy link
Member Author

Forgot about it... I'll try to get back to it "soon".

@GuillaumeGomez GuillaumeGomez force-pushed the lint-for-no-crate-level-doc branch from 93a12ca to 9f3d60d Compare February 11, 2020 12:17
@GuillaumeGomez
Copy link
Member Author

Updated!

@rust-highfive
Copy link
Collaborator

The job x86_64-gnu-llvm-7 of your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.
2020-02-11T12:17:35.5035168Z ========================== Starting Command Output ===========================
2020-02-11T12:17:35.5037432Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/897feab8-30f8-4e05-aacf-6a73f341c255.sh
2020-02-11T12:17:35.5037573Z 
2020-02-11T12:17:35.5040233Z ##[section]Finishing: Disable git automatic line ending conversion
2020-02-11T12:17:35.5045078Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/66938/merge to s
2020-02-11T12:17:35.5046473Z Task         : Get sources
2020-02-11T12:17:35.5046539Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-02-11T12:17:35.5046570Z Version      : 1.0.0
2020-02-11T12:17:35.5046599Z Author       : Microsoft
---
2020-02-11T12:17:36.2959486Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-02-11T12:17:36.3050244Z ##[command]git config gc.auto 0
2020-02-11T12:17:36.3110687Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-02-11T12:17:36.3172170Z ##[command]git config --get-all http.proxy
2020-02-11T12:17:36.3317105Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/66938/merge:refs/remotes/pull/66938/merge

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@petrochenkov
Copy link
Contributor

This PR is still missing motivation.

If the lint is not enabled by default, then we already have missing_docs that can be enabled.
If the lint is enabled by default in rustdoc runs, then we already have missing_docs that can be reported by rustdoc as well, it should have all the necessary information.

@GuillaumeGomez
Copy link
Member Author

The motivation is providing help for a specific kind of documentation. It'll also be set as warning by default.

As a sidenote, need to check what failed the tests...

@GuillaumeGomez GuillaumeGomez force-pushed the lint-for-no-crate-level-doc branch from 9f3d60d to 15dbb84 Compare February 11, 2020 15:18
@rust-highfive
Copy link
Collaborator

The job x86_64-gnu-llvm-7 of your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.
2020-02-11T15:18:41.3188364Z ========================== Starting Command Output ===========================
2020-02-11T15:18:41.3190975Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/920165ac-817c-490d-a978-93503a5d8d0a.sh
2020-02-11T15:18:41.3191016Z 
2020-02-11T15:18:41.3193924Z ##[section]Finishing: Disable git automatic line ending conversion
2020-02-11T15:18:41.3199976Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/66938/merge to s
2020-02-11T15:18:41.3202110Z Task         : Get sources
2020-02-11T15:18:41.3202201Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-02-11T15:18:41.3202235Z Version      : 1.0.0
2020-02-11T15:18:41.3202269Z Author       : Microsoft
---
2020-02-11T15:18:42.3998665Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-02-11T15:18:42.4010948Z ##[command]git config gc.auto 0
2020-02-11T15:18:42.4013392Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-02-11T15:18:42.4015480Z ##[command]git config --get-all http.proxy
2020-02-11T15:18:42.4022207Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/66938/merge:refs/remotes/pull/66938/merge
---
2020-02-11T16:20:37.0203785Z .................................................................................................... 1700/9627
2020-02-11T16:20:42.2295127Z .................................................................................................... 1800/9627
2020-02-11T16:20:54.8076929Z ..............................i..................................................................... 1900/9627
2020-02-11T16:21:02.7404864Z .................................................................................................... 2000/9627
2020-02-11T16:21:17.9725866Z ....................iiiii........................................................................... 2100/9627
2020-02-11T16:21:28.1773989Z .................................................................................................... 2300/9627
2020-02-11T16:21:30.6517363Z .................................................................................................... 2400/9627
2020-02-11T16:21:35.6557113Z .................................................................................................... 2500/9627
2020-02-11T16:21:57.4271474Z .................................................................................................... 2600/9627
---
2020-02-11T16:24:38.2679430Z .......................................................................i...............i............ 4900/9627
2020-02-11T16:24:46.2489331Z .................................................................................................... 5000/9627
2020-02-11T16:24:54.8435599Z .................................................................................................... 5100/9627
2020-02-11T16:24:59.7115747Z .............i...................................................................................... 5200/9627
2020-02-11T16:25:11.4007429Z .......................................................................................ii.ii........ 5300/9627
2020-02-11T16:25:15.4024041Z i...i............................................................................................... 5400/9627
2020-02-11T16:25:27.9140451Z .................................................................................................... 5600/9627
2020-02-11T16:25:36.9662345Z ...........................................................................i........................ 5700/9627
2020-02-11T16:25:44.2607123Z .................................................................................................... 5800/9627
2020-02-11T16:25:50.9346492Z .................................................................................................... 5900/9627
2020-02-11T16:25:50.9346492Z .................................................................................................... 5900/9627
2020-02-11T16:26:01.3165839Z ...................................................................ii...i..ii...........i........... 6000/9627
2020-02-11T16:26:23.7246995Z .................................................................................................... 6200/9627
2020-02-11T16:26:31.8351307Z .................................................................................................... 6300/9627
2020-02-11T16:26:38.3569847Z ...............................................................................................i..ii 6400/9627
2020-02-11T16:26:52.4833831Z .................................................................................................... 6500/9627
---
2020-02-11T16:28:59.2088419Z .................................................................................................... 7600/9627
2020-02-11T16:29:03.4087857Z .................................................................................................... 7700/9627
2020-02-11T16:29:09.1224568Z .................................................................................................... 7800/9627
2020-02-11T16:29:17.6242256Z .................................................................................................... 7900/9627
2020-02-11T16:29:26.7298153Z .....................................................................iiiiiii.i...................... 8000/9627
2020-02-11T16:29:42.8980115Z .........i......i................................................................................... 8200/9627
2020-02-11T16:29:48.4257128Z .................................................................................................... 8300/9627
2020-02-11T16:30:02.2932050Z .................................................................................................... 8400/9627
2020-02-11T16:30:12.3848348Z .................................................................................................... 8500/9627
---
2020-02-11T16:32:44.3934478Z  finished in 7.729
2020-02-11T16:32:44.4134607Z Check compiletest suite=codegen mode=codegen (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T16:32:44.6445755Z 
2020-02-11T16:32:44.6446951Z running 178 tests
2020-02-11T16:32:47.7627311Z iiii......i...........ii..iiii...i....i...........i............i..i..................i....i......... 100/178
2020-02-11T16:32:50.2548425Z ...i.i.i...iii..iiiiiiiiiiiiiiii.......................iii............ii......
2020-02-11T16:32:50.2550041Z 
2020-02-11T16:32:50.2552177Z  finished in 5.842
2020-02-11T16:32:50.2741843Z Check compiletest suite=codegen-units mode=codegen-units (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T16:32:50.4702455Z 
---
2020-02-11T16:32:52.4895811Z  finished in 2.215
2020-02-11T16:32:52.5101588Z Check compiletest suite=assembly mode=assembly (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T16:32:52.6757078Z 
2020-02-11T16:32:52.6757423Z running 9 tests
2020-02-11T16:32:52.6762525Z iiiiiiiii
2020-02-11T16:32:52.6763113Z 
2020-02-11T16:32:52.6771905Z  finished in 0.166
2020-02-11T16:32:52.7030048Z Check compiletest suite=incremental mode=incremental (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T16:32:52.9045100Z 
---
2020-02-11T16:33:13.8067098Z  finished in 21.104
2020-02-11T16:33:13.8289245Z Check compiletest suite=debuginfo mode=debuginfo (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T16:33:14.0217092Z 
2020-02-11T16:33:14.0248103Z running 116 tests
2020-02-11T16:33:28.0676814Z iiiii..i.....i..i...i..i.i.i..i..i..ii....i.i....ii..........iiii..........i.....i..i.......ii.i.ii. 100/116
2020-02-11T16:33:29.9007522Z ....iiii.....ii.
2020-02-11T16:33:29.9014040Z 
2020-02-11T16:33:29.9021044Z  finished in 16.073
2020-02-11T16:33:29.9028287Z Uplifting stage1 rustc (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T16:33:29.9029152Z Copying stage2 rustc from stage1 (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu / x86_64-unknown-linux-gnu)
---
2020-02-11T16:47:39.8940597Z 
2020-02-11T16:47:39.8941552Z    Doc-tests core
2020-02-11T16:47:44.8881752Z 
2020-02-11T16:47:44.8882557Z running 2471 tests
2020-02-11T16:47:54.0910355Z ......iiiii......................................................................................... 100/2471
2020-02-11T16:48:03.1426351Z ..................................................................................ii................ 200/2471
2020-02-11T16:48:24.5504159Z .................i.................................................................................. 400/2471
2020-02-11T16:48:24.5504159Z .................i.................................................................................. 400/2471
2020-02-11T16:48:34.3630568Z ......................................................................i..i..................iiii.... 500/2471
2020-02-11T16:48:50.8139312Z .................................................................................................... 700/2471
2020-02-11T16:48:59.5209313Z .................................................................................................... 800/2471
2020-02-11T16:49:08.1379152Z .................................................................................................... 900/2471
2020-02-11T16:49:16.9687867Z .................................................................................................... 1000/2471
---
2020-02-11T16:52:58.4180179Z 
2020-02-11T16:52:58.4180435Z running 1009 tests
2020-02-11T16:53:16.5382306Z i................................................................................................... 100/1009
2020-02-11T16:53:26.4133759Z .................................................................................................... 200/1009
2020-02-11T16:53:33.3967761Z ..................iii......i......i...i......i...................................................... 300/1009
2020-02-11T16:53:38.4019028Z .................................................................................................... 400/1009
2020-02-11T16:53:45.0767105Z ............................................i..i.....................................ii............. 500/1009
2020-02-11T16:53:57.6187567Z .................................................................................................... 700/1009
2020-02-11T16:53:57.6187567Z .................................................................................................... 700/1009
2020-02-11T16:54:04.3492106Z ...................................iiii............................................................. 800/1009
2020-02-11T16:54:18.6586243Z .................................................................................................... 900/1009
2020-02-11T16:54:25.6618748Z .........................................................iiii....................................... 1000/1009
2020-02-11T16:54:26.0518660Z test result: ok. 989 passed; 0 failed; 20 ignored; 0 measured; 0 filtered out
2020-02-11T16:54:26.0519335Z 
2020-02-11T16:54:26.0632493Z  finished in 171.765
2020-02-11T16:54:26.0644230Z Testing term stage1 (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
---
2020-02-11T17:15:25.9240845Z  finished in 42.507
2020-02-11T17:15:25.9552247Z Check compiletest suite=run-make-fulldeps mode=run-make (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-02-11T17:15:26.1916054Z 
2020-02-11T17:15:26.1916819Z running 208 tests
2020-02-11T17:16:00.2930665Z ......................i...ii.....................................................................i.. 100/208
2020-02-11T17:16:38.7729582Z ......................................iiiiii......i..............iii................................ 200/208
2020-02-11T17:16:40.5588170Z test result: ok. 193 passed; 0 failed; 15 ignored; 0 measured; 0 filtered out
2020-02-11T17:16:40.5588245Z 
2020-02-11T17:16:40.5595063Z  finished in 74.604
2020-02-11T17:16:40.5603384Z doc tests for: /checkout/src/doc/rustdoc/src/advanced-features.md
---
2020-02-11T17:17:09.9892179Z - note: lint level defined here
2020-02-11T17:17:09.9892345Z + note: the lint level is defined here
2020-02-11T17:17:09.9892726Z 4   --> $DIR/no-crate-level-doc-lint.rs:1:9
2020-02-11T17:17:09.9892892Z 5    |
2020-02-11T17:17:09.9893081Z 6 LL | #![deny(missing_crate_level_doc)]
2020-02-11T17:17:09.9893354Z 
2020-02-11T17:17:09.9893486Z The actual stderr differed from the expected stderr.
2020-02-11T17:17:09.9894001Z Actual stderr saved to /checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc-ui/no-crate-level-doc-lint/no-crate-level-doc-lint.stderr
2020-02-11T17:17:09.9894001Z Actual stderr saved to /checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc-ui/no-crate-level-doc-lint/no-crate-level-doc-lint.stderr
2020-02-11T17:17:09.9894681Z To update references, rerun the tests and pass the `--bless` flag
2020-02-11T17:17:09.9895621Z To only update this specific test, also pass `--test-args no-crate-level-doc-lint.rs`
2020-02-11T17:17:09.9895935Z error: 1 errors occurred comparing output.
2020-02-11T17:17:09.9896093Z status: exit code: 1
2020-02-11T17:17:09.9896093Z status: exit code: 1
2020-02-11T17:17:09.9898171Z command: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustdoc" "/checkout/src/test/rustdoc-ui/no-crate-level-doc-lint.rs" "-Zthreads=1" "--target=x86_64-unknown-linux-gnu" "--error-format" "json" "-Zui-testing" "-Zdeduplicate-diagnostics=no" "-o" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc-ui/no-crate-level-doc-lint" "-Cdebuginfo=0" "-Zunstable-options" "-Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "-L" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc-ui/no-crate-level-doc-lint/auxiliary"
2020-02-11T17:17:09.9899254Z ------------------------------------------
2020-02-11T17:17:09.9899432Z 
2020-02-11T17:17:09.9899831Z ------------------------------------------
2020-02-11T17:17:09.9900033Z stderr:
2020-02-11T17:17:09.9900033Z stderr:
2020-02-11T17:17:09.9900481Z ------------------------------------------
2020-02-11T17:17:09.9901898Z error: no documentation found for this crate's top-level module
2020-02-11T17:17:09.9901960Z    |
2020-02-11T17:17:09.9902026Z note: the lint level is defined here
2020-02-11T17:17:09.9902286Z   --> /checkout/src/test/rustdoc-ui/no-crate-level-doc-lint.rs:1:9
2020-02-11T17:17:09.9902334Z    |
2020-02-11T17:17:09.9902377Z LL | #![deny(missing_crate_level_doc)]
2020-02-11T17:17:09.9902487Z    = help: The following guide may be of use:
2020-02-11T17:17:09.9902743Z            https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html
2020-02-11T17:17:09.9902800Z 
2020-02-11T17:17:09.9902864Z error: aborting due to previous error
---
2020-02-11T17:17:09.9910815Z thread 'main' panicked at 'Some tests failed', src/tools/compiletest/src/main.rs:348:22
2020-02-11T17:17:09.9910893Z note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
2020-02-11T17:17:09.9917682Z 
2020-02-11T17:17:09.9917970Z 
2020-02-11T17:17:09.9919863Z command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-tools-bin/compiletest" "--compile-lib-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib" "--run-lib-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib/rustlib/x86_64-unknown-linux-gnu/lib" "--rustc-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustc" "--rustdoc-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustdoc" "--src-base" "/checkout/src/test/rustdoc-ui" "--build-base" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc-ui" "--stage-id" "stage2-x86_64-unknown-linux-gnu" "--mode" "ui" "--target" "x86_64-unknown-linux-gnu" "--host" "x86_64-unknown-linux-gnu" "--llvm-filecheck" "/usr/lib/llvm-7/bin/FileCheck" "--host-rustcflags" "-Cdebuginfo=0 -Zunstable-options  -Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--target-rustcflags" "-Cdebuginfo=0 -Zunstable-options  -Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--docck-python" "/usr/bin/python2.7" "--lldb-python" "/usr/bin/python2.7" "--gdb" "/usr/bin/gdb" "--quiet" "--llvm-version" "7.0.0\n" "--system-llvm" "--cc" "" "--cxx" "" "--cflags" "" "--llvm-components" "" "--adb-path" "adb" "--adb-test-dir" "/data/tmp/work" "--android-cross-path" "" "--color" "always"
2020-02-11T17:17:09.9920310Z 
2020-02-11T17:17:09.9929777Z 
2020-02-11T17:17:09.9929911Z failed to run: /checkout/obj/build/bootstrap/debug/bootstrap test
2020-02-11T17:17:09.9929974Z Build completed unsuccessfully in 1:52:03
2020-02-11T17:17:09.9929974Z Build completed unsuccessfully in 1:52:03
2020-02-11T17:17:09.9988031Z == clock drift check ==
2020-02-11T17:17:10.0009782Z   local time: Tue Feb 11 17:17:10 UTC 2020
2020-02-11T17:17:10.8309274Z   network time: Tue, 11 Feb 2020 17:17:10 GMT
2020-02-11T17:17:10.8309988Z == end clock drift check ==
2020-02-11T17:17:11.0638329Z 
2020-02-11T17:17:11.0749809Z ##[error]Bash exited with code '1'.
2020-02-11T17:17:11.0762453Z ##[section]Finishing: Run build
2020-02-11T17:17:11.0782500Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/66938/merge to s
2020-02-11T17:17:11.0784154Z Task         : Get sources
2020-02-11T17:17:11.0784192Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-02-11T17:17:11.0784245Z Version      : 1.0.0
2020-02-11T17:17:11.0784293Z Author       : Microsoft
2020-02-11T17:17:11.0784293Z Author       : Microsoft
2020-02-11T17:17:11.0784331Z Help         : [More Information](https://go.microsoft.com/fwlink/?LinkId=798199)
2020-02-11T17:17:11.0784370Z ==============================================================================
2020-02-11T17:17:11.5336760Z Cleaning any cached credential from repository: rust-lang/rust (GitHub)
2020-02-11T17:17:11.5381065Z ##[section]Finishing: Checkout rust-lang/rust@refs/pull/66938/merge to s
2020-02-11T17:17:11.5511298Z Cleaning up task key
2020-02-11T17:17:11.5512125Z Start cleaning up orphan processes.
2020-02-11T17:17:11.5625472Z Terminate orphan process: pid (3431) (python)
2020-02-11T17:17:11.5962400Z ##[section]Finishing: Finalize Job

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@GuillaumeGomez GuillaumeGomez force-pushed the lint-for-no-crate-level-doc branch from 15dbb84 to d842bdb Compare February 12, 2020 13:47
@GuillaumeGomez
Copy link
Member Author

Oh, the lint sentence changed, nice.

@GuillaumeGomez GuillaumeGomez force-pushed the lint-for-no-crate-level-doc branch from d842bdb to 4d822ac Compare February 12, 2020 14:48
@GuillaumeGomez
Copy link
Member Author

Ping @kinnison

@GuillaumeGomez GuillaumeGomez force-pushed the lint-for-no-crate-level-doc branch from 4d822ac to be97eb4 Compare March 22, 2020 12:04
@GuillaumeGomez
Copy link
Member Author

I still have the concerns about insufficient motivation, and I'm not entirely sure this can be enabled by default.

It'll be visible only when running rustdoc, so unless you want to document your API, you'll never this warning.

I think this needs a feedback from larger audience.
RFC process is perhaps too heavy-weight for this, but it would be adequate to have a post on internals explaining in detail what this lints want to achieve and why it is useful and why it can be enabled by default.

If you see this warning, it means that you're trying to get your API documentation. At this point, if you don't know about how to document rust code, it'll come in handy. Otherwise, you can either ignore the lint or allow it. In any case, it won't impact much people who don't have the need for it.

@Dylan-DPC-zz
Copy link

@bors r+

@bors
Copy link
Contributor

bors commented Mar 23, 2020

📌 Commit be97eb4 has been approved by Dylan-DPC

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 23, 2020
Centril added a commit to Centril/rust that referenced this pull request Mar 23, 2020
…vel-doc, r=Dylan-DPC

Add lint when no doc is present at the crate-level

Follow-up of rust-lang#66267.

r? @kinnison
Centril added a commit to Centril/rust that referenced this pull request Mar 23, 2020
…vel-doc, r=Dylan-DPC

Add lint when no doc is present at the crate-level

Follow-up of rust-lang#66267.

r? @kinnison
@Dylan-DPC-zz
Copy link

eh sorry forgot to refresh the tab :D

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 23, 2020
@GuillaumeGomez
Copy link
Member Author

eh sorry forgot to refresh the tab :D

?

@Dylan-DPC-zz
Copy link

@bors r+

@bors
Copy link
Contributor

bors commented Mar 28, 2020

📌 Commit be97eb4 has been approved by Dylan-DPC

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 28, 2020
@bors
Copy link
Contributor

bors commented Mar 28, 2020

⌛ Testing commit be97eb4 with merge 7762131...

@bors
Copy link
Contributor

bors commented Mar 28, 2020

☀️ Test successful - checks-azure
Approved by: Dylan-DPC
Pushing 7762131 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Mar 28, 2020
@bors bors merged commit 7762131 into rust-lang:master Mar 28, 2020
@GuillaumeGomez GuillaumeGomez deleted the lint-for-no-crate-level-doc branch March 30, 2020 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-lang Relevant to the language team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.