From 78eb6ca145d5b6d82b19fef6cd4414b6e8a72395 Mon Sep 17 00:00:00 2001 From: dmitrykobets-msft <89153909+dmitrykobets-msft@users.noreply.github.com> Date: Thu, 23 Feb 2023 10:22:02 -0800 Subject: [PATCH] Document span_ext (#1098) `` is intended to mirror `` in the STL. `` provides convenience features that aren't part of ``. Address #1095 --- docs/headers.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/headers.md b/docs/headers.md index 3c4eb5f..e870eaf 100644 --- a/docs/headers.md +++ b/docs/headers.md @@ -599,7 +599,7 @@ Converts a `span` into a `span` of `byte`s. ## `` -This files is a companion for and included by [``](#user-content-H-span). +This file is a companion for and included by [``](#user-content-H-span), and should not be used on its own. It contains useful features that aren't part of the `std::span` API as found inside the STL `` header (with the exception of [`gsl::dynamic_extent`](#user-content-H-span_ext-dynamic_extent), which is included here due to implementation constraints). - [`gsl::dynamic_extent`](#user-content-H-span_ext-dynamic_extent) - [`gsl::span`](#user-content-H-span_ext-span) @@ -611,7 +611,9 @@ This files is a companion for and included by [``](#user-content-H-span). ### `gsl::dynamic_extent` -Defines the extent value to be used by all `gsl::span` with dynamic extent. +Defines the extent value to be used by all `gsl::span` with dynamic extent. + +Note: `std::dynamic_extent` is exposed by the STL `` header and so ideally `gsl::dynamic_extent` would be under [``](#user-content-H-span), but to avoid cyclic dependency issues it is under `` instead. ### `gsl::span`