You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GSL grammar fix, added missing plurality in full name (isocpp#1243)
* Renamed all appropriate instances of "guideline support library" to "guidelines support library".
* Renamed additional instances of "guideline support library" to "guidelines support library" in remaining files.
Copy file name to clipboardExpand all lines: CppCoreGuidelines.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ Supporting sections:
51
51
* [NR: Non-Rules and myths](#S-not)
52
52
* [RF: References](#S-references)
53
53
* [Pro: Profiles](#S-profile)
54
-
* [GSL: Guideline support library](#S-gsl)
54
+
* [GSL: Guidelines support library](#S-gsl)
55
55
* [NL: Naming and layout rules](#S-naming)
56
56
* [FAQ: Answers to frequently asked questions](#S-faq)
57
57
* [Appendix A: Libraries](#S-libraries)
@@ -422,7 +422,7 @@ Supporting sections:
422
422
* [NR: Non-Rules and myths](#S-not)
423
423
* [RF: References](#S-references)
424
424
* [Pro: Profiles](#S-profile)
425
-
* [GSL: Guideline support library](#S-gsl)
425
+
* [GSL: Guidelines support library](#S-gsl)
426
426
* [NL: Naming and layout rules](#S-naming)
427
427
* [FAQ: Answers to frequently asked questions](#S-faq)
428
428
* [Appendix A: Libraries](#S-libraries)
@@ -517,7 +517,7 @@ A well-designed library expresses intent (what is to be done, rather than just h
517
517
518
518
A C++ programmer should know the basics of the standard library, and use it where appropriate.
519
519
Any programmer should know the basics of the foundation libraries of the project being worked on, and use them appropriately.
520
-
Any programmer using these guidelines should know the [guideline support library](#S-gsl), and use it appropriately.
520
+
Any programmer using these guidelines should know the [guidelines support library](#S-gsl), and use it appropriately.
521
521
522
522
##### Example
523
523
@@ -608,7 +608,7 @@ The last variant makes it clear that we are not interested in the order in which
608
608
609
609
A programmer should be familiar with
610
610
611
-
* [The guideline support library](#S-gsl)
611
+
* [The guidelines support library](#S-gsl)
612
612
* [The ISO C++ Standard Library](#S-stdlib)
613
613
* Whatever foundation libraries are used for the current project(s)
614
614
@@ -1812,7 +1812,7 @@ However, that is less elegant and often less efficient than returning the object
1812
1812
so use smart pointers only if reference semantics are needed.
1813
1813
1814
1814
**Alternative**: Sometimes older code can't be modified because of ABI compatibility requirements or lack of resources.
1815
-
In that case, mark owning pointers using `owner` from the [guideline support library](#S-gsl):
1815
+
In that case, mark owning pointers using `owner` from the [guidelines support library](#S-gsl):
1816
1816
1817
1817
owner<X*> compute(args) // It is now clear that ownership is transferred
1818
1818
{
@@ -1862,7 +1862,7 @@ By stating the intent in source, implementers and tools can provide better diagn
1862
1862
1863
1863
##### Note
1864
1864
1865
-
`not_null` is defined in the [guideline support library](#S-gsl).
1865
+
`not_null` is defined in the [guidelines support library](#S-gsl).
1866
1866
1867
1867
##### Note
1868
1868
@@ -11209,7 +11209,7 @@ A key example is basic narrowing:
11209
11209
11210
11210
##### Note
11211
11211
11212
-
The guideline support library offers a `narrow_cast` operation for specifying that narrowing is acceptable and a `narrow` ("narrow if") that throws an exception if a narrowing would throw away information:
11212
+
The guidelines support library offers a `narrow_cast` operation for specifying that narrowing is acceptable and a `narrow` ("narrow if") that throws an exception if a narrowing would throw away information:
11213
11213
11214
11214
i = narrow_cast<int>(d); // OK (you asked for it): narrowing: i becomes 7
11215
11215
i = narrow<int>(d); // OK: throws narrowing_error
@@ -20052,14 +20052,14 @@ Once completely enforced through a combination of style rules, static analysis,
20052
20052
* avoids undefined behavior by enforcing a key C++ language rule
20053
20053
20054
20054
20055
-
# <a name="S-gsl"></a>GSL: Guideline support library
20055
+
# <a name="S-gsl"></a>GSL: Guidelines support library
20056
20056
20057
20057
The GSL is a small library of facilities designed to support this set of guidelines.
20058
20058
Without these facilities, the guidelines would have to be far more restrictive on language details.
20059
20059
20060
20060
The Core Guidelines support library is defined in namespace `gsl` and the names may be aliases for standard library or other well-known library names. Using the (compile-time) indirection through the `gsl` namespace allows for experimentation and for local variants of the support facilities.
20061
20061
20062
-
The GSL is header only, and can be found at [GSL: Guideline support library](https://github.com/Microsoft/GSL).
20062
+
The GSL is header only, and can be found at [GSL: Guidelines support library](https://github.com/Microsoft/GSL).
20063
20063
The support library facilities are designed to be extremely lightweight (zero-overhead) so that they impose no overhead compared to using conventional alternatives.
20064
20064
Where desirable, they can be "instrumented" with additional functionality (e.g., checks) for tasks such as debugging.
20065
20065
@@ -20872,7 +20872,7 @@ Avoid other HTML tags and other extensions.
20872
20872
20873
20873
Note: We are not yet consistent with this style.
20874
20874
20875
-
### <a name="Faq-gsl"></a>FAQ.50: What is the GSL (guideline support library)?
20875
+
### <a name="Faq-gsl"></a>FAQ.50: What is the GSL (guidelines support library)?
20876
20876
20877
20877
The GSL is the small set of types and aliases specified in these guidelines. As of this writing, their specification herein is too sparse; we plan to add a WG21-style interface specification to ensure that different implementations agree, and to propose as a contribution for possible standardization, subject as usual to whatever the committee decides to accept/improve/alter/reject.
20878
20878
@@ -20888,7 +20888,7 @@ We are reluctant to bless one particular implementation because we do not want t
20888
20888
20889
20889
Because we want to use them immediately, and because they are temporary in that we want to retire them as soon as types that fill the same needs exist in the standard library.
20890
20890
20891
-
### <a name="Faq-gsl-iso"></a>FAQ.54: Has the GSL (guideline support library) been approved by the ISO C++ standards committee?
20891
+
### <a name="Faq-gsl-iso"></a>FAQ.54: Has the GSL (guidelines support library) been approved by the ISO C++ standards committee?
20892
20892
20893
20893
No. The GSL exists only to supply a few types and aliases that are not currently in the standard library. If the committee decides on standardized versions (of these or other types that fill the same need) then they can be removed from the GSL.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ The guidelines themselves are found at [CppCoreGuidelines](CppCoreGuidelines.md)
14
14
15
15
The Guidelines are a constantly evolving document without a strict "release" cadence. Bjarne Stroustrup periodically reviews the document and increments the version number in the introduction. [Checkins that increment the version number](https://github.com/isocpp/CppCoreGuidelines/releases) are tagged in git.
16
16
17
-
Many of the guidelines make use of the header-only Guideline Support Library. One implementation is available at [GSL: Guideline Support Library](https://github.com/Microsoft/GSL).
17
+
Many of the guidelines make use of the header-only Guidelines Support Library. One implementation is available at [GSL: Guidelines Support Library](https://github.com/Microsoft/GSL).
0 commit comments