Skip to content

Make sure rustdocs use 'Constructs` instead of 'Creates' #3868

@tcharding

Description

@tcharding

Right before we 1.0 any crate we should check that no 'Creates' have slipped in. (I personally keep forgetting that we favour 'Constructs'.)

E.g.

git grep Creates
...
bitcoin/src/taproot/mod.rs:870:    /// Creates an iterator over all leaves (including hidden leaves) in the tree.
bitcoin/tests/bip_174.rs:129:/// Creates the initial transaction, called by the PSBT Creator.
bitcoin/tests/bip_174.rs:197:/// Creates the initial PSBT, called by the Creator. Verifies against BIP 174 test vector.
hashes/src/internal_macros.rs:58: /// Creates a type called `Hash` and implements the standard general hashing interface for it.
hashes/src/macros.rs:45: /// Creates a new newtype around a [`Hash`] type.
internals/src/error/parse_error.rs:3:  /// Creates an error type intended for string parsing errors.
units/src/amount/tests.rs:362:// Creates individual test functions to make it easier to find which check failed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    1.0Issues and PRs required or helping to stabilize the API

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions