diff options
| author | flip1995 <hello@philkrones.com> | 2020-10-09 12:45:29 +0200 |
|---|---|---|
| committer | flip1995 <hello@philkrones.com> | 2020-10-09 12:45:29 +0200 |
| commit | 6b8d25ecda4cbc7266bd1499466dfc5737c9fbdf (patch) | |
| tree | 0f353c1f10fb8561c21df5aacc8cf4ee49ba5fa8 /src/tools/clippy/doc | |
| parent | 9a74fb726ec40be398c55bce66c6d0b1a91d106c (diff) | |
| parent | 2f6439ae6a6803d030cceb3ee14c9150e91b328b (diff) | |
| download | rust-6b8d25ecda4cbc7266bd1499466dfc5737c9fbdf.tar.gz rust-6b8d25ecda4cbc7266bd1499466dfc5737c9fbdf.zip | |
Merge commit '2f6439ae6a6803d030cceb3ee14c9150e91b328b' into clippyup
Diffstat (limited to 'src/tools/clippy/doc')
| -rw-r--r-- | src/tools/clippy/doc/adding_lints.md | 3 | ||||
| -rw-r--r-- | src/tools/clippy/doc/basics.md | 6 |
2 files changed, 8 insertions, 1 deletions
diff --git a/src/tools/clippy/doc/adding_lints.md b/src/tools/clippy/doc/adding_lints.md index 21e0f6f4fc7..2869c3bf7d4 100644 --- a/src/tools/clippy/doc/adding_lints.md +++ b/src/tools/clippy/doc/adding_lints.md @@ -189,7 +189,8 @@ declare_clippy_lint! { * The section of lines prefixed with `///` constitutes the lint documentation section. This is the default documentation style and will be displayed - [like this][example_lint_page]. + [like this][example_lint_page]. To render and open this documentation locally + in a browser, run `cargo dev serve`. * `FOO_FUNCTIONS` is the name of our lint. Be sure to follow the [lint naming guidelines][lint_naming] here when naming your lint. In short, the name should state the thing that is being checked for and diff --git a/src/tools/clippy/doc/basics.md b/src/tools/clippy/doc/basics.md index c81e7f6e069..38959e2331b 100644 --- a/src/tools/clippy/doc/basics.md +++ b/src/tools/clippy/doc/basics.md @@ -13,6 +13,7 @@ Lints] or [Common Tools]. - [Setup](#setup) - [Building and Testing](#building-and-testing) - [`cargo dev`](#cargo-dev) + - [PR](#pr) ## Get the Code @@ -110,3 +111,8 @@ cargo dev new_lint # (experimental) Setup Clippy to work with rust-analyzer cargo dev ra-setup ``` + +## PR + +We follow a rustc no merge-commit policy. +See <https://rustc-dev-guide.rust-lang.org/contributing.html#opening-a-pr>. |