Expand in-place tags page
#4753
Conversation
|
@Rageking8 : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit e2e0da6:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/standard-library/optional-class.md | Details | ||
| docs/standard-library/in-place-t-struct.md | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/standard-library/in-place-t-struct-in-place-type-t-struct-in-place-index-t-struct.md | ✅Succeeded | ||
| docs/standard-library/utility.md | ✅Succeeded |
docs/standard-library/optional-class.md
- Line 14, Column 43: [Warning: file-not-found - See documentation]
Invalid file link: 'in-place-t-struct.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit d2783ec: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
PRMerger Results
|
Note: new articles must be submitted via the private repo so if you accept this, you'll need to move the commits (or we can help). Also, an article deletion requires an entry in the redirection.json (again in the private repo so we can verify that it works) #label:"aq-pr-triaged" |
prmerger-automator
bot
added
the
aq-pr-triaged
| f1_keywords: ["utility<in_place_t>", "utility/std::in_place_t", "utility<in_place_type_t>", "utility/std::in_place_type_t", "utility<in_place_index_t>", "utility/std::in_place_index_t"] | ||
| helpviewer_keywords: ["utility<in_place_t> struct"] | ||
| --- | ||
| # in_place_t Struct, in_place_type_t Struct, in_place_index_t Struct |
There was a problem hiding this comment.
Please code escape. Otherwise, auto machine translation may have modify these
| @@ -75,7 +75,7 @@ Pairs are widely used in the C++ Standard Library. They are required both as the | |||
| |-|-| | |||
| |[from_chars_result](../standard-library/from-chars-result-structure.md)|A struct used for `from_chars`.| | |||
| |[identity](../standard-library/identity-structure.md)|A struct that provides a type definition as the template parameter.| | |||
| |[in_place_t](../standard-library/in-place-t-struct.md)|Also includes structs `in_place_type_t` and `in_place_index_t`.| | |||
| |[in_place_t, in_place_type_t, in_place_index_t](../standard-library/in-place-t-struct-in-place-type-t-struct-in-place-index-t-struct.md)|Types used to control in-place construction.| | |||
There was a problem hiding this comment.
please code escape. I know that this file hasn't been doing that. Many of these were written before we realized what was going on with machine translation, so when we touch a file we code escape functions, types, etc.
| --- | ||
| # in_place_t Struct, in_place_type_t Struct, in_place_index_t Struct | ||
|
|
||
| The empty structure type `in_place_t` can be passed into constructors of `expected` class, [`optional` class](optional-class.md) or [`single_view` class](single-view-class.md) for in-place construction of the contained type. The empty structure type `in_place_type_t` can be passed into constructors of [`any` class](any-class.md) or [`variant` class](variant-class.md) to specify the type of the object. The empty structure type `in_place_index_t` can be passed into constructors of [`variant` class](variant-class.md) to specify the index of the object. |
There was a problem hiding this comment.
Weren't these introduced in C++17? We should tag them as such and indicate that they should use at least /std:c++17 to compile. I realize that the topic you started from was lame in this regard.
| --- | ||
| # in_place_t Struct, in_place_type_t Struct, in_place_index_t Struct | ||
|
|
||
| The empty structure type `in_place_t` can be passed into constructors of `expected` class, [`optional` class](optional-class.md) or [`single_view` class](single-view-class.md) for in-place construction of the contained type. The empty structure type `in_place_type_t` can be passed into constructors of [`any` class](any-class.md) or [`variant` class](variant-class.md) to specify the type of the object. The empty structure type `in_place_index_t` can be passed into constructors of [`variant` class](variant-class.md) to specify the index of the object. |
There was a problem hiding this comment.
This says where we can pass them, but not why.
The ISO spec in section 20.2.7 has some explanation that would be good to make readable and add to the remarks.
There was a problem hiding this comment.
Hi, thank you for adding to the docs.
There's a deleted file here, which we can't do unless we are willing to go through updating the redirect for the file. I don't think you want to do that.
We are missing the ## See also section.
Left other notes in the file.
|
@TylerMSFT Would having a separate page for each of the 3 types ( |
Hi @Rageking8: it's viable, it's just a question of which tradeoff(s) you want to accept. Writing an article is only the first part, and sometimes the smallest part, of the work that an article will require over its lifetime. There's maintenance, metrics, portfolio weeding, etc. Having lots of tiny files makes that harder, adds to the table of contents which might then make it harder to navigate. When they are related, it makes the reader do more work to pull together the overall picture because they have to click around to different articles. It's a subjective call in the end. I don't see a compelling reason to make them separate topics in this case, but there may be another point of view worth considering. Why would you like to break them up? |
Not sure if this is the best way since the file name is quite long.