chore: Rename Component::name_in_manifest and short_name_in_manifest method to name and short_name#4778
Open
Cloud0310 wants to merge 1 commit intorust-lang:mainfrom
Open
chore: Rename Component::name_in_manifest and short_name_in_manifest method to name and short_name#4778Cloud0310 wants to merge 1 commit intorust-lang:mainfrom
Component::name_in_manifest and short_name_in_manifest method to name and short_name#4778Cloud0310 wants to merge 1 commit intorust-lang:mainfrom
Conversation
…t_name` accordingly In `Component`, these methods are not related to the final name associated with manifest. On the `Manifest` side, it have `name` and `short_name` for get the re-mapped component names. So, I think renaming these func names in Component helps clarify the the code.
Cloud0310
changed the title
Component::name_in_manifest and short_name_in_manifest method to name and short_nameComponent::name_in_manifest and short_name_in_manifest method to name and short_name
djc
approved these changes
Mar 26, 2026
rami3l
approved these changes
Mar 26, 2026
| } | ||
|
|
||
| pub fn short_name_in_manifest(&self) -> &String { | ||
| pub fn short_name(&self) -> &String { |
Member
There was a problem hiding this comment.
Nit: Kind of pre-existing, but I'd argue that to make this even less of a confusion going forward, it'd be cool to add doc comments to explicitly compare the Component:: and Manifest:: functions in question. It can be really simple.
How about something like the following in the impl Manifest block (not sure about the syntax, but the overall idea should be clear):
/// Returns the [`Component`]'s short name (not including the target) before renaming.
/// For the name after renaming, see [`Component::short_name()`].
/// Returns the [`Component`]'s name (including the target) before renaming.
/// For the name after renaming, see [`Component::name()`].
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These function on
Componentis not related toManifest, so renaming them to distinguish againstManifest::name()andManifest::short_name().Founded this problem when I was dealing with #4768. By naming, two functions looks like should be the same, but they're actually different things.
ref: src/dist/manifest.rs#L55-L62 src/dist/manifest.rs#L55-L62