Skip to content

Commit 6dd1432

Browse files
jeffreylindseyhsutter
authored andcommitted
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.
1 parent 04b2fab commit 6dd1432

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ they can be freely copied and modified to meet your organization's needs.
1010
We encourage contributions to the C++ Core Guidelines in a number of ways:
1111
- **Individual feedback** Are you a developer who is passionate about your code? Join the discussion in
1212
[Issues](https://github.com/isocpp/CppCoreGuidelines/issues). We want to know which rules resonate with you and which don't. Were any rules
13-
inordinately difficult to apply? Does your compiler vendor's Guideline Support Library (e.g.,
13+
inordinately difficult to apply? Does your compiler vendor's Guidelines Support Library (e.g.,
1414
[Microsoft's implementation of the GSL](https://github.com/microsoft/gsl)) suit your needs in adopting these guidelines?
1515
- **Organizational adoption** While the guidelines are designed to be broadly adoptable they are also intended to be modified to fit your
1616
organization's particular needs. We encourage your organization to fork this repo and create your own copy of these guidelines with changes

CppCoreGuidelines.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Supporting sections:
5151
* [NR: Non-Rules and myths](#S-not)
5252
* [RF: References](#S-references)
5353
* [Pro: Profiles](#S-profile)
54-
* [GSL: Guideline support library](#S-gsl)
54+
* [GSL: Guidelines support library](#S-gsl)
5555
* [NL: Naming and layout rules](#S-naming)
5656
* [FAQ: Answers to frequently asked questions](#S-faq)
5757
* [Appendix A: Libraries](#S-libraries)
@@ -422,7 +422,7 @@ Supporting sections:
422422
* [NR: Non-Rules and myths](#S-not)
423423
* [RF: References](#S-references)
424424
* [Pro: Profiles](#S-profile)
425-
* [GSL: Guideline support library](#S-gsl)
425+
* [GSL: Guidelines support library](#S-gsl)
426426
* [NL: Naming and layout rules](#S-naming)
427427
* [FAQ: Answers to frequently asked questions](#S-faq)
428428
* [Appendix A: Libraries](#S-libraries)
@@ -517,7 +517,7 @@ A well-designed library expresses intent (what is to be done, rather than just h
517517

518518
A C++ programmer should know the basics of the standard library, and use it where appropriate.
519519
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.
521521

522522
##### Example
523523

@@ -608,7 +608,7 @@ The last variant makes it clear that we are not interested in the order in which
608608

609609
A programmer should be familiar with
610610

611-
* [The guideline support library](#S-gsl)
611+
* [The guidelines support library](#S-gsl)
612612
* [The ISO C++ Standard Library](#S-stdlib)
613613
* Whatever foundation libraries are used for the current project(s)
614614

@@ -1812,7 +1812,7 @@ However, that is less elegant and often less efficient than returning the object
18121812
so use smart pointers only if reference semantics are needed.
18131813

18141814
**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):
18161816

18171817
owner<X*> compute(args) // It is now clear that ownership is transferred
18181818
{
@@ -1862,7 +1862,7 @@ By stating the intent in source, implementers and tools can provide better diagn
18621862

18631863
##### Note
18641864

1865-
`not_null` is defined in the [guideline support library](#S-gsl).
1865+
`not_null` is defined in the [guidelines support library](#S-gsl).
18661866

18671867
##### Note
18681868

@@ -11209,7 +11209,7 @@ A key example is basic narrowing:
1120911209

1121011210
##### Note
1121111211

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:
1121311213

1121411214
i = narrow_cast<int>(d); // OK (you asked for it): narrowing: i becomes 7
1121511215
i = narrow<int>(d); // OK: throws narrowing_error
@@ -20052,14 +20052,14 @@ Once completely enforced through a combination of style rules, static analysis,
2005220052
* avoids undefined behavior by enforcing a key C++ language rule
2005320053

2005420054

20055-
# <a name="S-gsl"></a>GSL: Guideline support library
20055+
# <a name="S-gsl"></a>GSL: Guidelines support library
2005620056

2005720057
The GSL is a small library of facilities designed to support this set of guidelines.
2005820058
Without these facilities, the guidelines would have to be far more restrictive on language details.
2005920059

2006020060
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.
2006120061

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).
2006320063
The support library facilities are designed to be extremely lightweight (zero-overhead) so that they impose no overhead compared to using conventional alternatives.
2006420064
Where desirable, they can be "instrumented" with additional functionality (e.g., checks) for tasks such as debugging.
2006520065

@@ -20872,7 +20872,7 @@ Avoid other HTML tags and other extensions.
2087220872

2087320873
Note: We are not yet consistent with this style.
2087420874

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)?
2087620876

2087720877
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.
2087820878

@@ -20888,7 +20888,7 @@ We are reluctant to bless one particular implementation because we do not want t
2088820888

2088920889
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.
2089020890

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?
2089220892

2089320893
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.
2089420894

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The guidelines themselves are found at [CppCoreGuidelines](CppCoreGuidelines.md)
1414

1515
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.
1616

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).
1818

1919
## Background and scope
2020

docs/gsl-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Using the Guideline Support Library (GSL): A Tutorial and FAQ
2+
# Using the Guidelines Support Library (GSL): A Tutorial and FAQ
33

44
by Herb Sutter
55

0 commit comments

Comments
 (0)