Skip to content

Commit ff91c63

Browse files
committed
wiki -> docs
1 parent c64073b commit ff91c63

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ All notable changes to this project will be documented in this file.
308308

309309
## 0.0.74 — 2016-06-07
310310
* Fix bug with `cargo-clippy` JSON parsing
311-
* Add the `CLIPPY_DISABLE_WIKI_LINKS` environment variable to deactivate the
311+
* Add the `CLIPPY_DISABLE_DOCS_LINKS` environment variable to deactivate the
312312
“for further information visit *wiki-link*” message.
313313

314314
## 0.0.73 — 2016-06-05

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ You can also specify the path to the configuration file with:
152152
```
153153

154154
To deactivate the “for further information visit *wiki-link*” message you can
155-
define the `CLIPPY_DISABLE_WIKI_LINKS` environment variable.
155+
define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
156156

157157
### Allowing/denying lints
158158

clippy_lints/src/utils/mod.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -563,8 +563,8 @@ impl<'a> Drop for DiagnosticWrapper<'a> {
563563
}
564564

565565
impl<'a> DiagnosticWrapper<'a> {
566-
fn wiki_link(&mut self, lint: &'static Lint) {
567-
if env::var("CLIPPY_DISABLE_WIKI_LINKS").is_err() {
566+
fn docs_link(&mut self, lint: &'static Lint) {
567+
if env::var("CLIPPY_DISABLE_DOCS_LINKS").is_err() {
568568
self.0.help(&format!(
569569
"for further information visit https://rust-lang-nursery.github.io/rust-clippy/master/index.html#{}",
570570
lint.name_lower()
@@ -574,7 +574,7 @@ impl<'a> DiagnosticWrapper<'a> {
574574
}
575575

576576
pub fn span_lint<'a, T: LintContext<'a>>(cx: &T, lint: &'static Lint, sp: Span, msg: &str) {
577-
DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg)).wiki_link(lint);
577+
DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg)).docs_link(lint);
578578
}
579579

580580
pub fn span_help_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
@@ -586,7 +586,7 @@ pub fn span_help_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
586586
) {
587587
let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, span, msg));
588588
db.0.help(help);
589-
db.wiki_link(lint);
589+
db.docs_link(lint);
590590
}
591591

592592
pub fn span_note_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
@@ -603,7 +603,7 @@ pub fn span_note_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
603603
} else {
604604
db.0.span_note(note_span, note);
605605
}
606-
db.wiki_link(lint);
606+
db.docs_link(lint);
607607
}
608608

609609
pub fn span_lint_and_then<'a, 'tcx: 'a, T: LintContext<'tcx>, F>(
@@ -617,7 +617,7 @@ pub fn span_lint_and_then<'a, 'tcx: 'a, T: LintContext<'tcx>, F>(
617617
{
618618
let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg));
619619
f(&mut db.0);
620-
db.wiki_link(lint);
620+
db.docs_link(lint);
621621
}
622622

623623
pub fn span_lint_and_sugg<'a, 'tcx: 'a, T: LintContext<'tcx>>(

tests/compile-test.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ fn run_mode(dir: &'static str, mode: &'static str) {
2121
}
2222

2323
fn prepare_env() {
24-
set_var("CLIPPY_DISABLE_WIKI_LINKS", "true");
24+
set_var("CLIPPY_DISABLE_DOCS_LINKS", "true");
2525
}
2626

2727
#[test]

util/update_lints.py

100755100644
+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
nl_escape_re = re.compile(r'\\\n\s*')
3131

32-
wiki_link = 'https://rust-lang-nursery.github.io/rust-clippy/master/index.html'
32+
docs_link = 'https://rust-lang-nursery.github.io/rust-clippy/master/index.html'
3333

3434

3535
def collect(lints, deprecated_lints, restriction_lints, fn):
@@ -169,7 +169,7 @@ def main(print_only=False, check=False):
169169
'CHANGELOG.md',
170170
"<!-- begin autogenerated links to wiki -->",
171171
"<!-- end autogenerated links to wiki -->",
172-
lambda: ["[`{0}`]: {1}#{0}\n".format(l[1], wiki_link) for l in
172+
lambda: ["[`{0}`]: {1}#{0}\n".format(l[1], docs_link) for l in
173173
sorted(lints + restriction_lints + deprecated_lints,
174174
key=lambda l: l[1])],
175175
replace_start=False, write_back=not check)

0 commit comments

Comments
 (0)