mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 10:48:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

ruff_formatter crate doc comment fixes (#6677)

Browse source
This commit is contained in:
Chris Pryer 2023-08-19 12:42:02 -04:00 • committed by GitHub
parent 3849fa0cf1
commit 648333b8b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
crates/ruff_formatter/src/arguments.rs
View file

@ -61,8 +61,8 @@ impl<'fmt, Context> Argument<'fmt, Context> {
///
/// The [`format_args!`] macro will safely create an instance of this structure.
///
/// You can use the `Arguments<a>` that [`format_args!]` return in `Format` context as seen below.
/// It will call the `format` function for every of it's objects.
/// You can use the `Arguments<a>` that [`format_args!`] return in `Format` context as seen below.
/// It will call the `format` function for each of its objects.
///
/// ```rust
/// use ruff_formatter::prelude::*;

6
crates/ruff_formatter/src/lib.rs
View file

@ -1,12 +1,12 @@
//! Infrastructure for code formatting
//!
//! This module defines [`FormatElement`], an IR to format code documents and provides a mean to print
//! This module defines [`FormatElement`], an IR to format code documents and provides a means to print
//! such a document to a string. Objects that know how to format themselves implement the [Format] trait.
//!
//! ## Formatting Traits
//!
//! * [Format]: Implemented by objects that can be formatted.
//! * [`FormatRule`]: Rule that knows how to format an object of another type. Necessary in the situation where
//! * [`Format`]: Implemented by objects that can be formatted.
//! * [`FormatRule`]: Rule that knows how to format an object of another type. Useful in the situation where
//! it's necessary to implement [Format] on an object from another crate. This module defines the
//! [`FormatRefWithRule`] and [`FormatOwnedWithRule`] structs to pass an item with its corresponding rule.
//! * [`FormatWithRule`] implemented by objects that know how to format another type. Useful for implementing

2
crates/ruff_formatter/src/macros.rs
View file

@ -1,6 +1,6 @@
/// Constructs the parameters for other formatting macros.
///
/// This macro functions by taking a list of objects implementing [`crate::Format`]. It canonicalize the
/// This macro functions by taking a list of objects implementing [`crate::Format`]. It will canonicalize the
/// arguments into a single type.
///
/// This macro produces a value of type [`crate::Arguments`]. This value can be passed to