language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-28 04:45:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Unify comment terminology with that of rome_formatter (#2979)

Browse source
This commit is contained in:
Charlie Marsh 2023-02-16 22:02:25 -05:00 • committed by GitHub
parent 34664a0ca0
commit 180541a924
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 64 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

38
crates/ruff_python_formatter/src/format/expr.rs
View file

@ -27,11 +27,11 @@ fn format_starred(
) -> FormatResult<()> {
write!(f, [text("*"), value.format()])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -56,11 +56,11 @@ fn format_name(
) -> FormatResult<()> {
write!(f, [literal(Range::from_located(expr))])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -310,11 +310,11 @@ fn format_call(
write!(f, [text("(")])?;
write!(f, [text(")")])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -331,11 +331,11 @@ fn format_call(
} else {
write!(f, [text("(")])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -400,7 +400,7 @@ fn format_call(
// Apply any dangling trailing comments.
for trivia in &expr.trivia {
if matches!(trivia.relationship, Relationship::Dangling) {
if let TriviaKind::StandaloneComment(range) = trivia.kind {
if let TriviaKind::OwnLineComment(range) = trivia.kind {
write!(f, [expand_parent()])?;
write!(f, [hard_line_break()])?;
write!(f, [literal(range)])?;
@ -593,11 +593,11 @@ fn format_compare(
write!(f, [group(&format_args![comparators[i].format()])])?;
}
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -709,11 +709,11 @@ fn format_attribute(
write!(f, [text(".")])?;
write!(f, [dynamic_text(attr, TextSize::default())])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -749,11 +749,11 @@ fn format_bool_op(
}
}
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -791,11 +791,11 @@ fn format_bin_op(
}
write!(f, [group(&format_args![right.format()])])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in expr.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -886,7 +886,7 @@ impl Format<ASTFormatContext<'_>> for FormatExpr<'_> {
// Any leading comments come on the line before.
for trivia in &self.item.trivia {
if matches!(trivia.relationship, Relationship::Leading) {
if let TriviaKind::StandaloneComment(range) = trivia.kind {
if let TriviaKind::OwnLineComment(range) = trivia.kind {
write!(f, [expand_parent()])?;
write!(f, [literal(range)])?;
write!(f, [hard_line_break()])?;
@ -958,7 +958,7 @@ impl Format<ASTFormatContext<'_>> for FormatExpr<'_> {
// Any trailing comments come on the lines after.
for trivia in &self.item.trivia {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::StandaloneComment(range) = trivia.kind {
if let TriviaKind::OwnLineComment(range) = trivia.kind {
write!(f, [expand_parent()])?;
write!(f, [literal(range)])?;
write!(f, [hard_line_break()])?;

24
crates/ruff_python_formatter/src/format/stmt.rs
View file

@ -20,11 +20,11 @@ fn format_pass(f: &mut Formatter<ASTFormatContext<'_>>, stmt: &Stmt) -> FormatRe
// Write the statement body.
write!(f, [text("pass")])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in stmt.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -206,11 +206,11 @@ fn format_func_def(
write!(f, [text(":")])?;
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in stmt.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -255,11 +255,11 @@ fn format_assign(
)?;
}
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in stmt.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -543,11 +543,11 @@ fn format_import_from(
)?;
}
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in stmt.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -592,11 +592,11 @@ fn format_expr(
)?;
}
// Apply any inline comments.
// Format any end-of-line comments.
let mut first = true;
for range in stmt.trivia.iter().filter_map(|trivia| {
if matches!(trivia.relationship, Relationship::Trailing) {
if let TriviaKind::InlineComment(range) = trivia.kind {
if let TriviaKind::EndOfLineComment(range) = trivia.kind {
Some(range)
} else {
None
@ -665,7 +665,7 @@ impl Format<ASTFormatContext<'_>> for FormatStmt<'_> {
TriviaKind::EmptyLine => {
write!(f, [empty_line()])?;
}
TriviaKind::StandaloneComment(range) => {
TriviaKind::OwnLineComment(range) => {
write!(f, [literal(range), hard_line_break()])?;
}
_ => {}
@ -808,7 +808,7 @@ impl Format<ASTFormatContext<'_>> for FormatStmt<'_> {
TriviaKind::EmptyLine => {
write!(f, [empty_line()])?;
}
TriviaKind::StandaloneComment(range) => {
TriviaKind::OwnLineComment(range) => {
write!(f, [literal(range), hard_line_break()])?;
}
_ => {}