Rustdoc-Json: More inconsistant names #100961
Labels
A-rustdoc-json
Area: Rustdoc JSON backend
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
rustbot
added
A-rustdoc-json
notriddle
added a commit
to notriddle/rust
that referenced
this issue
Sep 26, 2022
…illaumeGomez Rustdoc-Json: List impls for primitives Closes rust-lang#101695 Partially addresses rust-lang#100961 r? `@GuillaumeGomez`
notriddle
added a commit
to notriddle/rust
that referenced
this issue
Sep 26, 2022
…illaumeGomez Rustdoc-Json: List impls for primitives Closes rust-lang#101695 Partially addresses rust-lang#100961 r? ``@GuillaumeGomez``
rust-cloud-vms bot
pushed a commit
to aDotInTheVoid/rust
that referenced
this issue
Jul 3, 2024
As suggested [on zulip][1], there's no need to use `GenericBound` here, as the only bound a lifetime can have is that it outlives other lifetimes. While we're making breaking changes here, I also renamed it from using "region" to "lifetime", as this is more user-aligned. See [this comment][2] for details. [1]: https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/.60ItemEnum.3A.3AOpaqueTy.60/near/448871430 [2]: rust-lang#100961 (comment)
rust-cloud-vms bot
pushed a commit
to aDotInTheVoid/rust
that referenced
this issue
Jul 3, 2024
As suggested [on zulip][1], there's no need to use `GenericBound` here, as the only bound a lifetime can have is that it outlives other lifetimes. While we're making breaking changes here, I also renamed it from using "region" to "lifetime", as this is more user-aligned. See [this comment][2] for details. [1]: https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/.60ItemEnum.3A.3AOpaqueTy.60/near/448871430 [2]: rust-lang#100961 (comment)
jhpratt
added a commit
to jhpratt/rust
that referenced
this issue
Jul 4, 2024
…uillaumeGomez rustdoc-json: Better representation of lifetime bounds in where clauses. As suggested [on zulip][1] (CC `@its-the-shrimp),` there's no need to use `GenericBound` here, as the only bound a lifetime can have is that it outlives other lifetimes. While we're making breaking changes here, I also renamed it from using "region" to "lifetime", as this is more user-aligned. See [this comment][2] for details. [1]: https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/.60ItemEnum.3A.3AOpaqueTy.60/near/448871430 [2]: rust-lang#100961 (comment) r? `@GuillaumeGomez`
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Jul 4, 2024
Rollup merge of rust-lang#127289 - aDotInTheVoid:rustdoc-json-lt, r=GuillaumeGomez rustdoc-json: Better representation of lifetime bounds in where clauses. As suggested [on zulip][1] (CC `@its-the-shrimp),` there's no need to use `GenericBound` here, as the only bound a lifetime can have is that it outlives other lifetimes. While we're making breaking changes here, I also renamed it from using "region" to "lifetime", as this is more user-aligned. See [this comment][2] for details. [1]: https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/.60ItemEnum.3A.3AOpaqueTy.60/near/448871430 [2]: rust-lang#100961 (comment) r? `@GuillaumeGomez`
|
workingjubilee
added a commit
to workingjubilee/rustc
that referenced
this issue
Sep 9, 2024
…rename, r=aDotInTheVoid rustdoc: normalise type/field names Updates rust-lang#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
workingjubilee
added a commit
to workingjubilee/rustc
that referenced
this issue
Sep 9, 2024
…rename, r=aDotInTheVoid rustdoc: normalise type/field names Updates rust-lang#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
workingjubilee
added a commit
to workingjubilee/rustc
that referenced
this issue
Sep 9, 2024
…rename, r=aDotInTheVoid rustdoc: normalise type/field names Updates rust-lang#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
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Sep 9, 2024
Rollup merge of rust-lang#128667 - its-the-shrimp:rustdoc_json_types_rename, r=aDotInTheVoid rustdoc: normalise type/field names Updates rust-lang#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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
use's are refered to asImport's (rustdoc: normalise type/field names #128667)FnDecluses shortFn, butFunctionandFunctionPointerdon't abbreviate (rustdoc: normalise type/field names #128667)OpaqueTyuses shortTy, but fulltypeuses everywhere else (removed in rustdoc: Remove OpaqueTy #127276)Headernot calledFunctionHeader(rustdoc: normalise type/field names #128667)Headerhas fieldsasync_,const_andunsafe_, but should beis_async(etc), like rest of types. (rustdoc: normalise type/field names #128667)ItemKindhasPrimitive, butItemEnumhasPrimitiveType( Rustdoc-Json: List impls for primitives #102321)ItemEnum::ForeignTypeshould beExternType, as foreign refers to a different rust crate, but it's actually a non rust type (rustdoc: normalise type/field names #128667)AssocItemConstraint's `binding field should probably be renamed as followup to the binding->contraint change in rustdoc: normalise type/field names #128667StructFieldisn't just used for struct's, but also variant fieldsWherePredicate::RegionPredicateshoud probaby uselifetimeinstead. The region/lifetime thing has a history on the compiller side (Consistently use "region" terminology in later stages of the compiler compiler-team#634, Tracking issue for dejargonification #110254), but we should avoid Region on the user-facing side. Done in rustdoc-json: Better representation of lifetime bounds in where clauses. #127289Somewhat of a followup to #94889
@rustbot modify labels: +T-rustdoc +A-rustdoc-json
The text was updated successfully, but these errors were encountered: