Fix outdated doc comment #144838

Kivooeo · 2025-08-02T18:16:25Z

This updates the documentation comment for Type::is_doc_subtype_of to more accurately describe its purpose as a subtyping check, rather than equality

fixes #138572

r? @tgross35

lolbinarycat · 2025-08-04T19:19:39Z

src/librustdoc/clean/types.rs

@@ -1534,10 +1534,10 @@ impl Type {
        matches!(self, Type::Path { path: Path { res: Res::Def(DefKind::TyAlias, _), .. } })
    }

-    /// Check if two types are "the same" for documentation purposes.
+    /// Check if this type is a subtype of another type for documentation purposes.


I feel like the current behavior of the function is closer to checking if another type is a subtype of this type (this was the argument flipping I mentioned in the original issue).

Maybe my intuition is backwards, so I would wait for a second opinion before renaming the function or anything, but at the very least it should at least have a not of how generics are handled.

It seems to me that function is working exactly like self.is_doc_subtype_of(other) and example in doc comment showing it

let generic = Type::Generic(rustc_span::symbol::sym::Any); let unit = Type::Primitive(PrimitiveType::Unit); assert!(unit.is_doc_subtype_of(&generic, &cache));

it reads like "unit is subtype of generic" which is true, or am I missing something?

src/librustdoc/clean/types.rs

Kivooeo · 2025-08-04T20:22:36Z

Changed Placeholder with Infer in doc comment for now

tgross35 · 2025-08-04T20:48:56Z

r? @tgross35

Why me? This is a rustdoc change

r? rustdoc

Kivooeo · 2025-08-04T20:53:08Z

For some reasons I thought that you are in rustdoc and was like "I guess rustbot will assign Trevor anyway" 😅

tgross35 · 2025-08-04T21:06:25Z

Even if I was, anybody on the relevant teams can do doc reviews :)

notriddle · 2025-08-16T00:44:44Z

@bors r+

bors · 2025-08-16T00:44:46Z

📌 Commit 970ac40 has been approved by notriddle

It is now in the queue for this repository.

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? `@tgross35`

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ``@tgross35``

Rollup of 11 pull requests Successful merges: - #139345 (Extend `QueryStability` to handle `IntoIterator` implementations) - #144838 (Fix outdated doc comment) - #145206 (Port `#[custom_mir(..)]` to the new attribute system) - #145208 (Implement declarative (`macro_rules!`) derive macros (RFC 3698)) - #145309 (Fix `-Zregparm` for LLVM builtins) - #145355 (Add codegen test for issue 122734) - #145420 (cg_llvm: Use LLVM-C bindings for `LLVMSetTailCallKind`, `LLVMGetTypeKind`) - #145451 (Add static glibc to the nix dev shell) - #145460 (Speedup `copy_src_dirs` in bootstrap) - #145476 (Fix typo in doc for library/std/src/fs.rs#set_permissions) - #145485 (Fix deprecation attributes on foreign statics) r? `@ghost` `@rustbot` modify labels: rollup

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ```@tgross35```

Rollup of 10 pull requests Successful merges: - #140794 (Add information about group a lint belongs to) - #144476 (rustdoc-search: search backend with partitioned suffix tree) - #144838 (Fix outdated doc comment) - #145206 (Port `#[custom_mir(..)]` to the new attribute system) - #145208 (Implement declarative (`macro_rules!`) derive macros (RFC 3698)) - #145420 (cg_llvm: Use LLVM-C bindings for `LLVMSetTailCallKind`, `LLVMGetTypeKind`) - #145451 (Add static glibc to the nix dev shell) - #145460 (Speedup `copy_src_dirs` in bootstrap) - #145476 (Fix typo in doc for library/std/src/fs.rs#set_permissions) - #145485 (Fix deprecation attributes on foreign statics) r? `@ghost` `@rustbot` modify labels: rollup

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ````@tgross35````

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? `````@tgross35`````

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ``````@tgross35``````

Rollup of 10 pull requests Successful merges: - #144476 (rustdoc-search: search backend with partitioned suffix tree) - #144838 (Fix outdated doc comment) - #145206 (Port `#[custom_mir(..)]` to the new attribute system) - #145208 (Implement declarative (`macro_rules!`) derive macros (RFC 3698)) - #145420 (cg_llvm: Use LLVM-C bindings for `LLVMSetTailCallKind`, `LLVMGetTypeKind`) - #145451 (Add static glibc to the nix dev shell) - #145460 (Speedup `copy_src_dirs` in bootstrap) - #145476 (Fix typo in doc for library/std/src/fs.rs#set_permissions) - #145485 (Fix deprecation attributes on foreign statics) - #145489 (library: Migrate from `cfg_if` to `cfg_select`) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 9 pull requests Successful merges: - #144476 (rustdoc-search: search backend with partitioned suffix tree) - #144838 (Fix outdated doc comment) - #145206 (Port `#[custom_mir(..)]` to the new attribute system) - #145208 (Implement declarative (`macro_rules!`) derive macros (RFC 3698)) - #145420 (cg_llvm: Use LLVM-C bindings for `LLVMSetTailCallKind`, `LLVMGetTypeKind`) - #145451 (Add static glibc to the nix dev shell) - #145460 (Speedup `copy_src_dirs` in bootstrap) - #145476 (Fix typo in doc for library/std/src/fs.rs#set_permissions) - #145485 (Fix deprecation attributes on foreign statics) r? `@ghost` `@rustbot` modify labels: rollup

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ```````@tgross35```````

Rollup of 10 pull requests Successful merges: - #144838 (Fix outdated doc comment) - #145206 (Port `#[custom_mir(..)]` to the new attribute system) - #145208 (Implement declarative (`macro_rules!`) derive macros (RFC 3698)) - #145309 (Fix `-Zregparm` for LLVM builtins) - #145355 (Add codegen test for issue 122734) - #145420 (cg_llvm: Use LLVM-C bindings for `LLVMSetTailCallKind`, `LLVMGetTypeKind`) - #145451 (Add static glibc to the nix dev shell) - #145460 (Speedup `copy_src_dirs` in bootstrap) - #145476 (Fix typo in doc for library/std/src/fs.rs#set_permissions) - #145485 (Fix deprecation attributes on foreign statics) r? `@ghost` `@rustbot` modify labels: rollup

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ````````@tgross35````````

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? `````````@tgross35`````````

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ``````````@tgross35``````````

Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes rust-lang#138572 r? ```````````@tgross35```````````

Rollup of 10 pull requests Successful merges: - #144838 (Fix outdated doc comment) - #145206 (Port `#[custom_mir(..)]` to the new attribute system) - #145208 (Implement declarative (`macro_rules!`) derive macros (RFC 3698)) - #145309 (Fix `-Zregparm` for LLVM builtins) - #145355 (Add codegen test for issue 122734) - #145420 (cg_llvm: Use LLVM-C bindings for `LLVMSetTailCallKind`, `LLVMGetTypeKind`) - #145451 (Add static glibc to the nix dev shell) - #145460 (Speedup `copy_src_dirs` in bootstrap) - #145476 (Fix typo in doc for library/std/src/fs.rs#set_permissions) - #145485 (Fix deprecation attributes on foreign statics) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #144838 - Kivooeo:doc-subtype, r=notriddle Fix outdated doc comment This updates the documentation comment for `Type::is_doc_subtype_of` to more accurately describe its purpose as a subtyping check, rather than equality fixes #138572 r? ````````````@tgross35````````````

rustbot assigned tgross35 Aug 2, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 2, 2025

lolbinarycat reviewed Aug 4, 2025

View reviewed changes

src/librustdoc/clean/types.rs Outdated Show resolved Hide resolved

updated doc comment

970ac40

Kivooeo force-pushed the doc-subtype branch from 38d51e1 to 970ac40 Compare August 4, 2025 20:22

rustbot assigned notriddle and unassigned tgross35 Aug 4, 2025

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 16, 2025

jhpratt mentioned this pull request Aug 16, 2025

Rollup of 5 pull requests #145483

Closed

Zalathar mentioned this pull request Aug 16, 2025

Rollup of 11 pull requests #145488

Closed

Zalathar mentioned this pull request Aug 17, 2025

Rollup of 10 pull requests #145517

Closed

Zalathar mentioned this pull request Aug 17, 2025

Rollup of 9 pull requests #145519

Closed

Zalathar mentioned this pull request Aug 17, 2025

Rollup of 10 pull requests #145521

Closed

Zalathar mentioned this pull request Aug 17, 2025

Rollup of 10 pull requests #145526

Closed

jhpratt mentioned this pull request Aug 17, 2025

Manual rollup of 19 pull requests #145545

Closed

jhpratt mentioned this pull request Aug 17, 2025

Rollup of 19 pull requests #145546

Closed

Zalathar mentioned this pull request Aug 18, 2025

Rollup of 10 pull requests #145551

Merged

bors merged commit b94842d into rust-lang:master Aug 18, 2025
10 checks passed

rustbot added this to the 1.91.0 milestone Aug 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix outdated doc comment #144838

Fix outdated doc comment #144838

Uh oh!

Kivooeo commented Aug 2, 2025 •

edited by rustbot

Loading

Uh oh!

lolbinarycat Aug 4, 2025

Uh oh!

Kivooeo Aug 4, 2025

Uh oh!

Uh oh!

Kivooeo commented Aug 4, 2025

Uh oh!

tgross35 commented Aug 4, 2025

Uh oh!

Kivooeo commented Aug 4, 2025

Uh oh!

tgross35 commented Aug 4, 2025

Uh oh!

notriddle commented Aug 16, 2025

Uh oh!

bors commented Aug 16, 2025

Uh oh!

Uh oh!

Uh oh!

Fix outdated doc comment #144838

Fix outdated doc comment #144838

Uh oh!

Conversation

Kivooeo commented Aug 2, 2025 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lolbinarycat Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

Kivooeo Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Kivooeo commented Aug 4, 2025

Uh oh!

tgross35 commented Aug 4, 2025

Uh oh!

Kivooeo commented Aug 4, 2025

Uh oh!

tgross35 commented Aug 4, 2025

Uh oh!

notriddle commented Aug 16, 2025

Uh oh!

bors commented Aug 16, 2025

Uh oh!

Uh oh!

Uh oh!

Kivooeo commented Aug 2, 2025 •

edited by rustbot

Loading