Skip to content

Commit

Permalink
Revert "Change config option from format_doc_comments to format_code_…
Browse files Browse the repository at this point in the history
…in_doc_comments."

This reverts commit 6a6924c.
  • Loading branch information
xiongmao86 committed May 8, 2019
1 parent 6a6924c commit 97d7216
Show file tree
Hide file tree
Showing 17 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -1978,9 +1978,9 @@ fn main() {
}
```

## `format_code_in_doc_comments`
## `format_doc_comments`

Format code snippet included in doc comments.
Format doc comments.

- **Default value**: `false`
- **Possible values**: `true`, `false`
Expand Down
4 changes: 2 additions & 2 deletions src/comment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ fn identify_comment(
trim_left_preserve_layout(first_group, shape.indent, config)?
} else if !config.normalize_comments()
&& !config.wrap_comments()
&& !config.format_code_in_doc_comments()
&& !config.format_doc_comments()
{
light_rewrite_comment(first_group, shape.indent, config, is_doc_comment)
} else {
Expand Down Expand Up @@ -656,7 +656,7 @@ impl<'a> CommentRewrite<'a> {
_ => {
let mut config = self.fmt.config.clone();
config.set().wrap_comments(false);
if config.format_code_in_doc_comments() {
if config.format_doc_comments() {
if let Some(s) =
crate::format_code_block(&self.code_block_buffer, &config)
{
Expand Down
2 changes: 1 addition & 1 deletion src/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ create_config! {

// Comments. macros, and strings
wrap_comments: bool, false, false, "Break comments to fit on the line";
format_code_in_doc_comments: bool, false, false, "Format the code snippet in doc comments.";
format_doc_comments: bool, false, false, "Format doc comments.";
comment_width: usize, 80, false,
"Maximum length of comments. No effect unless wrap_comments = true";
normalize_comments: bool, false, false, "Convert /* */ comments to // comments where possible";
Expand Down
2 changes: 1 addition & 1 deletion tests/source/doc-comment-with-example.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

/// Foo
///
Expand Down
2 changes: 1 addition & 1 deletion tests/source/invalid-rust-code-in-doc-comment.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

/// ```rust
/// if (true) { … }
Expand Down
2 changes: 1 addition & 1 deletion tests/source/issue-2520.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

//! ```rust
//! println!( "hello, world" );
Expand Down
2 changes: 1 addition & 1 deletion tests/source/issue-2523.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

// Do not unindent macro calls in comment with unformattable syntax.
//! ```rust
Expand Down
2 changes: 1 addition & 1 deletion tests/source/issue-3055/original.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

/// Vestibulum elit nibh, rhoncus non, euismod sit amet, pretium eu, enim. Nunc commodo ultricies dui.
///
Expand Down
2 changes: 1 addition & 1 deletion tests/source/itemized-blocks/no_wrap.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

//! This is a list:
//! * Outer
Expand Down
2 changes: 1 addition & 1 deletion tests/source/itemized-blocks/wrap.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true
// rustfmt-max_width: 50

//! This is a list:
Expand Down
2 changes: 1 addition & 1 deletion tests/target/doc-comment-with-example.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

/// Foo
///
Expand Down
2 changes: 1 addition & 1 deletion tests/target/invalid-rust-code-in-doc-comment.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

/// ```rust
/// if (true) { … }
Expand Down
2 changes: 1 addition & 1 deletion tests/target/issue-2520.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

//! ```rust
//! println!("hello, world");
Expand Down
2 changes: 1 addition & 1 deletion tests/target/issue-2523.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

// Do not unindent macro calls in comment with unformattable syntax.
//! ```rust
Expand Down
2 changes: 1 addition & 1 deletion tests/target/issue-3055/original.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

/// Vestibulum elit nibh, rhoncus non, euismod sit amet, pretium eu, enim. Nunc
/// commodo ultricies dui.
Expand Down
2 changes: 1 addition & 1 deletion tests/target/itemized-blocks/no_wrap.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true

//! This is a list:
//! * Outer
Expand Down
2 changes: 1 addition & 1 deletion tests/target/itemized-blocks/wrap.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-format_doc_comments: true
// rustfmt-max_width: 50

//! This is a list:
Expand Down

0 comments on commit 97d7216

Please sign in to comment.