]> git.lizzy.rs Git - rust.git/commit
Rollup merge of #102058 - mqudsi:path_extension_docs, r=thomcc
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>
Wed, 21 Sep 2022 13:31:09 +0000 (19:01 +0530)
committerGitHub <noreply@github.com>
Wed, 21 Sep 2022 13:31:09 +0000 (19:01 +0530)
commit77d063b9544e9f438c56474efea4e07ab0d0e1e4
treeae73a215c4aa8f03d143654de711369a9429143b
parent7d7f55599ac2c4d433d4390339ea9a52489dbe0e
parentc291d2adecbf13685ed321d7699ba7bb0b60806a
Rollup merge of #102058 - mqudsi:path_extension_docs, r=thomcc

Clarify Path::extension() semantics in docs abstract

State up-front and center what shape the returned extension will have, without making the user read through the description and examples.

This is a doc-only change. There are no changes to the API contract and the clarification is in line with what was already stated/promised in the existing doc text - just clarified, summarized, and served bright and early.

Rationale: Various frameworks and libraries for different platforms have their different conventions as to whether an "extension" is ".ext" or just "ext" and anyone that's had to deal with this ambiguity in the past is always double- or triple-checking to make sure the function call returns an extension that matches the expected semantics. Offer the answer to this important question right off the bat instead of making them dig to find it.

```@rustbot``` label +A-docs