Skip to content

Commit c5fbb81

Browse files
beinhaerterWerner Henze
and
Werner Henze
authored
documentation (#1200)
- reintroduce documentation internal links - remove `gsl::` prefix in table so it is the same as in the other tables - fix documentation for span::element_type Co-authored-by: Werner Henze <[email protected]>
1 parent 7fabaa4 commit c5fbb81

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,12 @@ u32string_span | &#x2610; | Deprecated. An alias to `basic
7474
cu32string_span | &#x2610; | Deprecated. An alias to `basic_string_span` with a char type of `const char32_t`
7575

7676
## The following features have been adopted by WG21. They are deprecated in GSL.
77-
Feature | Deprecated Since | Notes
78-
-----------------------------------|------------------|------
79-
gsl::unique_ptr | C++11 | Use std::unique_ptr instead.
80-
gsl::shared_ptr | C++11 | Use std::shared_ptr instead.
81-
gsl::byte | C++17 | Use std::byte instead.
82-
gsl:joining_thread | C++20 (Note: Not yet implemented in GSL) | Use std::jthread instead.
77+
Feature | Deprecated Since | Notes
78+
------------------------------------------------------------------|------------------|------
79+
[unique_ptr](docs/headers.md#user-content-H-pointers-unique_ptr) | C++11 | Use std::unique_ptr instead.
80+
[shared_ptr](docs/headers.md#user-content-H-pointers-shared_ptr) | C++11 | Use std::shared_ptr instead.
81+
[byte](docs/headers.md#user-content-H-byte-byte) | C++17 | Use std::byte instead.
82+
joining_thread | C++20 (Note: Not yet implemented in GSL) | Use std::jthread instead.
8383

8484
This is based on [CppCoreGuidelines semi-specification](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#gsl-guidelines-support-library).
8585

docs/headers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ See [F.23: Use a `not_null<T>` to indicate that “null” is not a valid value]
230230
using element_type = T;
231231
```
232232

233-
The type of the pointed-to object.
233+
The type of the pointer or smart pointer that is managed by this object.
234234

235235
#### Member functions
236236

0 commit comments

Comments
 (0)