Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add notes and examples about non-intuitive PathBuf::set_extension behavior #104298

Merged
merged 1 commit into from
Jan 3, 2023
Merged

Add notes and examples about non-intuitive PathBuf::set_extension behavior #104298

merged 1 commit into from
Jan 3, 2023

Conversation

tbu-
Copy link
Contributor

@tbu- tbu- commented Nov 11, 2022

Basically, passing the empty string will actually remove the extension instead of setting it to the empty string. This might change what is considered to be an extension. Additionally, passing an extension that contains dots will make the path only consider the last part of it to be the new extension.

@rustbot
Copy link
Collaborator

rustbot commented Nov 11, 2022

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @m-ou-se (or someone else) soon.

Please see the contribution instructions for more information.

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 11, 2022
@rustbot
Copy link
Collaborator

rustbot commented Nov 11, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

compiler-errors
compiler-errors reviewed Dec 27, 2022
View reviewed changes
library/std/src/path.rs Outdated Show resolved Hide resolved
library/std/src/path.rs Outdated Show resolved Hide resolved
m-ou-se
m-ou-se reviewed Dec 30, 2022
View reviewed changes
library/std/src/path.rs Outdated
Comment on lines 1431 to 1434
/// Note that there are some exceptions when the parameter contains dots
/// (then the new [`self.extension`] will only be the last part), or if the
/// parameter is the empty string and the file stem also contains internal
/// dots.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a bit vague. How about something like this?

Suggested change
/// Note that there are some exceptions when the parameter contains dots
/// (then the new [`self.extension`] will only be the last part), or if the
/// parameter is the empty string and the file stem also contains internal
/// dots.
/// The new `extension` may contain dots and will be used in its entirety,
/// but only the part after the final dot will be reflected in [`self.extension()`][Self::extension].
/// See the examples below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, added. Also added the part about empty parameter and file stem with internal dots which was missing from your wording.

@m-ou-se m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 30, 2022
@tbu-
Add notes and examples about non-intuitive PathBuf::set_extension b…
40916ef 
…ehavior

Basically, passing the empty string will actually remove the extension
instead of setting it to the empty string. This might change what is
considered to be an extension. Additionally, passing an extension that
contains dots will make the path only consider the last part of it to be
the new extension.
@tbu-
Copy link
Contributor Author

tbu- commented Dec 31, 2022

@rustbot label +S-waiting-on-review -S-waiting-on-author

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 31, 2022
@m-ou-se
Copy link
Member

m-ou-se commented Jan 2, 2023

@bors r+

@bors
Copy link
Contributor

bors commented Jan 2, 2023

📌 Commit 40916ef has been approved by m-ou-se

It is now in the queue for this repository.

@bors 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 Jan 2, 2023
@compiler-errors compiler-errors mentioned this pull request Jan 2, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 3, 2023
@bors
Auto merge of rust-lang#106386 - compiler-errors:rollup-dxjv18b, r=co…
481c9ba 
…mpiler-errors

Rollup of 8 pull requests

Successful merges:

 - rust-lang#95985 (Add PhantomData marker to Context to make Context !Send and !Sync)
 - rust-lang#104298 (Add notes and examples about non-intuitive `PathBuf::set_extension` behavior)
 - rust-lang#105558 (Reduce HIR debug output)
 - rust-lang#106315 (Cleanup `mingw-tidy` docker job)
 - rust-lang#106354 (Rustdoc-Json: Report discriminant on all kinds of enum variant.)
 - rust-lang#106366 (Fix rustdoc ICE on bad typedef with mismatching types)
 - rust-lang#106376 (Update books)
 - rust-lang#106383 (Document some of the AST nodes)

Failed merges:

 - rust-lang#106356 (clean: Remove `ctor_kind` from `VariantStruct`.)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit da1ca5d into rust-lang:master Jan 3, 2023
@rustbot rustbot added this to the 1.68.0 milestone Jan 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@compiler-errors compiler-errors compiler-errors left review comments

@m-ou-se m-ou-se m-ou-se left review comments

Assignees

@m-ou-se m-ou-se

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.68.0
Development

Successfully merging this pull request may close these issues.
5 participants
@tbu- @rustbot @m-ou-se @bors @compiler-errors