Skip to content

Commit 8fed08d

Browse files
committed
Auto merge of #4346 - atouchet:links, r=flip1995
Update Readme <!-- Thank you for making Clippy better! We're collecting our changelog from pull request descriptions. If your PR only updates to the latest nightly, you can leave the `changelog` entry as `none`. Otherwise, please write a short comment explaining your change. If your PR fixes an issue, you can add "fixes #issue_number" into this PR description. This way the issue will be automatically closed when your PR is merged. If you added a new lint, here's a checklist for things that will be checked during review or continuous integration. - [ ] Followed [lint naming conventions][lint_naming] - [ ] Added passing UI tests (including committed `.stderr` file) - [ ] `cargo test` passes locally - [ ] Executed `util/dev update_lints` - [ ] Added lint documentation - [ ] Run `cargo fmt` Note that you can skip the above if you are just opening a WIP PR in order to get feedback. Delete this line and everything above before opening your PR --> changelog: none
2 parents b041511 + 4b2825c commit 8fed08d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Table of contents:
3636

3737
* [Usage instructions](#usage)
3838
* [Configuration](#configuration)
39+
* [Contributing](#contributing)
3940
* [License](#license)
4041

4142
## Usage
@@ -52,7 +53,7 @@ subcommand.
5253

5354
#### Step 1: Install rustup
5455

55-
You can install [rustup](http://rustup.rs/) on supported platforms. This will help
56+
You can install [rustup](https://rustup.rs/) on supported platforms. This will help
5657
us install Clippy and its dependencies.
5758

5859
If you already have rustup installed, update to ensure you have the latest
@@ -88,8 +89,7 @@ in your code, you can use:
8889
cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
8990
```
9091

91-
*[Note](https://github.com/rust-lang/rust-clippy/wiki#a-word-of-warning):*
92-
Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
92+
*Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
9393

9494
### Travis CI
9595

@@ -113,20 +113,20 @@ script:
113113
```
114114

115115
If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
116-
In this case you can try to conditionally install Clippy from the git repo.
116+
In this case you can try to conditionally install Clippy from the Git repo.
117117

118118
```yaml
119119
language: rust
120120
rust:
121121
- nightly
122122
before_script:
123123
- rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
124-
# etc
124+
# etc.
125125
```
126126

127127
Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
128128
That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
129-
an error for clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
129+
an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
130130
line. (You can swap `clippy::all` with the specific lint category you are targeting.)
131131

132132
## Configuration
@@ -154,9 +154,9 @@ You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
154154
`#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
155155
lints prone to false positives.
156156

157-
* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc)
157+
* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)
158158

159-
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
159+
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
160160

161161
Note: `deny` produces errors instead of warnings.
162162

@@ -171,7 +171,7 @@ If you want to contribute to Clippy, you can find more information in [CONTRIBUT
171171
Copyright 2014-2019 The Rust Project Developers
172172

173173
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
174-
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
175-
<LICENSE-MIT or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)>, at your
174+
[https://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
175+
<LICENSE-MIT or [https://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)>, at your
176176
option. All files in the project carrying such notice may not be
177177
copied, modified, or distributed except according to those terms.

0 commit comments

Comments
 (0)