milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Use parameters instead of arguments in rustdocs 

The rustdocs use both `# Parameters` and `# Arguments` to mean the same
thing.

Change all of them to `# Parameters` to be consistent.
This commit is contained in:
Jamil Lambert 2025-04-22 10:43:13 +01:00
parent e2c7be6d2f
commit f22e997587
No known key found for this signature in database
GPG Key ID: 7F574053F8F17A64
3 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
chacha20_poly1305/src/lib.rs
View File

@ -75,7 +75,7 @@ impl ChaCha20Poly1305 {
/// Encrypt content in place and return the Poly1305 16-byte authentication tag. /// Encrypt content in place and return the Poly1305 16-byte authentication tag.
/// ///
/// # Arguments /// # Parameters
/// ///
/// - `content` - Plaintext to be encrypted in place. /// - `content` - Plaintext to be encrypted in place.
/// - `aad` - Optional metadata covered by the authentication tag. /// - `aad` - Optional metadata covered by the authentication tag.
@ -110,7 +110,7 @@ impl ChaCha20Poly1305 {
/// Decrypt the ciphertext in place if authentication tag is correct. /// Decrypt the ciphertext in place if authentication tag is correct.
/// ///
/// # Arguments /// # Parameters
/// ///
/// - `content` - Ciphertext to be decrypted in place. /// - `content` - Ciphertext to be decrypted in place.
/// - `tag` - 16-byte authentication tag. /// - `tag` - 16-byte authentication tag.

5
hashes/src/internal_macros.rs
View File

@ -5,7 +5,8 @@
/// Adds trait impls to the type called `Hash` in the current scope. /// Adds trait impls to the type called `Hash` in the current scope.
/// ///
/// Implements various conversion traits as well as the [`crate::Hash`] trait. /// Implements various conversion traits as well as the [`crate::Hash`] trait.
/// Arguments: ///
/// # Parameters
/// ///
/// * `$bits` - number of bits this hash type has /// * `$bits` - number of bits this hash type has
/// * `$reverse` - `bool` - `true` if the hash type should be displayed backwards, `false` /// * `$reverse` - `bool` - `true` if the hash type should be displayed backwards, `false`
@ -55,7 +56,7 @@ pub(crate) use hash_trait_impls;
/// The created type has a single field and will have all standard derives as well as an /// The created type has a single field and will have all standard derives as well as an
/// implementation of [`crate::Hash`]. /// implementation of [`crate::Hash`].
/// ///
/// Arguments: /// # Parameters
/// ///
/// * `$bits` - the number of bits of the hash type /// * `$bits` - the number of bits of the hash type
/// * `$reverse` - `true` if the hash should be displayed backwards, `false` otherwise /// * `$reverse` - `true` if the hash should be displayed backwards, `false` otherwise

4
units/src/parse.rs
View File

@ -139,7 +139,7 @@ fn int<T: Integer, S: AsRef<str> + Into<InputString>>(s: S) -> Result<T, ParseIn
/// * `TryFrom<Box<str>>` /// * `TryFrom<Box<str>>`
/// * `TryFrom<String>` /// * `TryFrom<String>`
/// ///
/// # Arguments /// # Parameters
/// ///
/// * `to` - the type converted to e.g., `impl From<&str> for $to`. /// * `to` - the type converted to e.g., `impl From<&str> for $to`.
/// * `err` - the error type returned by `$inner_fn` (implies returned by `FromStr` and `TryFrom`). /// * `err` - the error type returned by `$inner_fn` (implies returned by `FromStr` and `TryFrom`).
@ -204,7 +204,7 @@ macro_rules! impl_parse_str_from_int_infallible {
/// * `TryFrom<Box<str>>` /// * `TryFrom<Box<str>>`
/// * `TryFrom<String>` /// * `TryFrom<String>`
/// ///
/// # Arguments /// # Parameters
/// ///
/// * `to` - the type converted to e.g., `impl From<&str> for $to`. /// * `to` - the type converted to e.g., `impl From<&str> for $to`.
/// * `err` - the error type returned by `$inner_fn` (implies returned by `FromStr` and `TryFrom`). /// * `err` - the error type returned by `$inner_fn` (implies returned by `FromStr` and `TryFrom`).