Skip to content

rustdoc: normalise type/field names - #128667

Merged
bors merged 1 commit into
rust-lang:masterfrom
its-the-shrimp:rustdoc_json_types_rename
Sep 9, 2024
Merged

rustdoc: normalise type/field names#128667
bors merged 1 commit into
rust-lang:masterfrom
its-the-shrimp:rustdoc_json_types_rename

Conversation

@its-the-shrimp

@its-the-shrimp its-the-shrimp commented Aug 4, 2024

Copy link
Copy Markdown
Contributor

Updates #100961

  • Import -> Use, to better reflect the terminology of Rust & its syntax
  • TypeBinding -> AssocItemConstraint, to sync up with clean
  • FnDecl -> FunctionSignature, because that's what it is
  • Header -> FunctionHeader, because Header is a very word that's very heavily loaded with different meanings
  • ItemEnum::AssocType: default -> type, because those items appear in impl blocks as well, where they're not the "default"
  • ItemEnum::AssocConst: default -> value, see the previous point
  • ForeignType -> ExternType, because "foreign" is not the right word there
  • boolean fields' names made to consistently be a phrase that can be a yes/no answer, e.g. async -> is_async

The docs of ItemEnum::AssocType::type_ & of ItemEnum::AssocConst::value are also updated to be up to date with the clarification of the name of the fields

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-rustdoc-json Area: Rustdoc JSON backend S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.