Update `<array>` functions reference #5684

Rageking8 · 2025-08-20T11:17:30Z

Overall changes

Make template parameter names more readable
Add bunch of std:: and "Template parameters" headings
Simplify single "See also" link and update metadata

`get`

Add missing const&& overload

Overload #	`microsoft/STL`	`cplusplus/draft`
1	`stl/inc/array#L852-L853`	`source/containers.tex#L6099-L6100`
2	`stl/inc/array#L866-L867`	`source/containers.tex#L6103-L6104`
3	`stl/inc/array#L876-L877`	`source/containers.tex#L6101-L6102`
4	`stl/inc/array#L890-L891`	`source/containers.tex#L6105-L6106`

`swap`

For now, I skipped the noexcept specification introduced in C++17 as I need more time to think how to best represent it

Overload #	`microsoft/STL`	`cplusplus/draft`
1	`stl/inc/array#L771-L772`	`source/containers.tex#L6083-L6084`

`to_array`

Document C++20 std::to_array function
In the example output, the trailing spaces are preserved but the NUL character is stripped to prevent issues

Overload #	`microsoft/STL`	`cplusplus/draft`
1	`stl/inc/array#L828-L829`	`source/containers.tex#L6087-L6088`
2	`stl/inc/array#L837-L838`	`source/containers.tex#L6089-L6090`

prmerger-automator · 2025-08-20T11:17:44Z

@Rageking8 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

learn-build-service-prod · 2025-08-20T11:19:55Z

Learn Build status updates of commit d1f2f14:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/array-functions.md	✅Succeeded
docs/standard-library/array.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-08-20T11:19:59Z

PRMerger Results

Issue	Description
File Change Percent	This PR contains file(s) with more than 30% file change.

v-regandowner · 2025-08-20T13:47:58Z

@TylerMSFT - Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

Copilot

Pull Request Overview

This PR updates the <array> functions reference documentation to improve readability and completeness. The main purpose is to modernize the documentation with clearer template parameter names, consistent std:: prefixes, and addition of the missing C++20 std::to_array function.

Key changes:

Modernized template parameter names (T → Type, N → Size) and added std:: prefixes throughout
Added documentation for the C++20 std::to_array function with examples
Added missing const&& overload for the get function
Reorganized parameter sections with separate "Template parameters" headings

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
docs/standard-library/array.md	Added table entry for the new `to_array` function and updated metadata
docs/standard-library/array-functions.md	Updated all function signatures with modern naming, added complete `to_array` documentation, and improved structure

Copilot · 2025-09-24T21:58:37Z

docs/standard-library/array-functions.md

+constexpr T& get(std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr const T& get(const array<T, N>& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T& get(const std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr T&& get(array<T, N>&& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr T&& get(std::array<Type, Size>&& arr) noexcept;
+
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T&& get(const std::array<Type, Size>&& arr) noexcept;


The return types use T but the template parameter is named Type. The return types should be Type&, const Type&, Type&&, and const Type&& respectively to match the template parameter name.

Copilot · 2025-09-24T21:58:37Z

docs/standard-library/array-functions.md

+constexpr T& get(std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr const T& get(const array<T, N>& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T& get(const std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr T&& get(array<T, N>&& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr T&& get(std::array<Type, Size>&& arr) noexcept;
+
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T&& get(const std::array<Type, Size>&& arr) noexcept;


The return types use T but the template parameter is named Type. The return types should be Type&, const Type&, Type&&, and const Type&& respectively to match the template parameter name.

Copilot · 2025-09-24T21:58:37Z

docs/standard-library/array-functions.md

+constexpr T& get(std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr const T& get(const array<T, N>& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T& get(const std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr T&& get(array<T, N>&& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr T&& get(std::array<Type, Size>&& arr) noexcept;
+
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T&& get(const std::array<Type, Size>&& arr) noexcept;


The return types use T but the template parameter is named Type. The return types should be Type&, const Type&, Type&&, and const Type&& respectively to match the template parameter name.

Copilot · 2025-09-24T21:58:37Z

docs/standard-library/array-functions.md

+constexpr T& get(std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr const T& get(const array<T, N>& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T& get(const std::array<Type, Size>& arr) noexcept;

-template <int Index, class T, size_t N>
-constexpr T&& get(array<T, N>&& arr) noexcept;
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr T&& get(std::array<Type, Size>&& arr) noexcept;
+
+template <std::size_t Index, class Type, std::size_t Size>
+constexpr const T&& get(const std::array<Type, Size>&& arr) noexcept;


The return types use T but the template parameter is named Type. The return types should be Type&, const Type&, Type&&, and const Type&& respectively to match the template parameter name.

Rageking8 added 6 commits August 20, 2025 18:02

Update get syntax in <array> functions reference

09c5a32

Update swap syntax in <array> functions reference

b0d9bb4

Add "Template parameters" headings in <array> functions reference

e30b46e

Document C++20 std::to_array function

183ce44

Simplify single "See also" link in <array> functions reference

99323ab

Update metadata in 2 standard library topics

d1f2f14

prmerger-automator bot added the do-not-merge label Aug 20, 2025

prmerger-automator bot assigned TylerMSFT Aug 20, 2025

prmerger-automator bot requested a review from TylerMSFT August 20, 2025 11:17

prmerger-automator bot added Change sent to author standard-libraries/subsvc visual-cpp/svc labels Aug 20, 2025

prmerger-automator bot added the needs-human-review label Aug 20, 2025

prmerger-automator bot added the aq-pr-triaged Tracking label for the PR review team label Aug 20, 2025

v-dirichards self-assigned this Sep 24, 2025

v-dirichards requested a review from Copilot September 24, 2025 21:58

Copilot AI reviewed Sep 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update `<array>` functions reference #5684

Update `<array>` functions reference #5684

Uh oh!

Rageking8 commented Aug 20, 2025 •

edited

Loading

Uh oh!

prmerger-automator bot commented Aug 20, 2025

Uh oh!

learn-build-service-prod bot commented Aug 20, 2025

Uh oh!

prmerger-automator bot commented Aug 20, 2025

Uh oh!

v-regandowner commented Aug 20, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Update <array> functions reference #5684

Are you sure you want to change the base?

Update <array> functions reference #5684

Uh oh!

Conversation

Rageking8 commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overall changes

get

swap

to_array

Uh oh!

prmerger-automator bot commented Aug 20, 2025

Uh oh!

learn-build-service-prod bot commented Aug 20, 2025

✅ Validation status: passed

Uh oh!

prmerger-automator bot commented Aug 20, 2025

PRMerger Results

Uh oh!

v-regandowner commented Aug 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Update `<array>` functions reference #5684

Update `<array>` functions reference #5684

Rageking8 commented Aug 20, 2025 •

edited

Loading

`get`

`swap`

`to_array`