mirror of
https://github.com/isocpp/CppCoreGuidelines.git
synced 2024-03-22 13:30:58 +08:00
Intended heading level?
Following the heading levels throughout the doc, it seems these are typos.
This commit is contained in:
parent
bdb5d27a10
commit
7c90bdba50
|
@ -1137,7 +1137,7 @@ See
|
|||
There are many other kinds of tools, such as source code depositories, build tools, etc.,
|
||||
but those are beyond the scope of these guidelines.
|
||||
|
||||
###### Note
|
||||
##### Note
|
||||
|
||||
Be careful not to become dependent on over-elaborate or over-specialized tool chains.
|
||||
Those can make your otherwise portable code non-portable.
|
||||
|
@ -3898,7 +3898,7 @@ Note [multi-methods](https://parasol.tamu.edu/~yuriys/papers/OMM10.pdf).
|
|||
|
||||
The language requires operators `=`, `()`, `[]`, and `->` to be members.
|
||||
|
||||
###### Exception
|
||||
##### Exception
|
||||
|
||||
An overload set may have some members that do not directly access `private` data:
|
||||
|
||||
|
@ -7856,7 +7856,7 @@ A *naked union* is a union without an associated indicator which member (if any)
|
|||
so that the programmer has to keep track.
|
||||
Naked unions are a source of type errors.
|
||||
|
||||
###### Example, bad
|
||||
##### Example, bad
|
||||
|
||||
union Value {
|
||||
int x;
|
||||
|
@ -7879,7 +7879,7 @@ And, talking about "invisible", this code produced no output:
|
|||
v.x = 123;
|
||||
cout << v.d << '\n'; // BAD: undefined behavior
|
||||
|
||||
###### Alternative
|
||||
##### Alternative
|
||||
|
||||
Wrap a `union` in a class together with a type field.
|
||||
|
||||
|
@ -10818,7 +10818,7 @@ There is no such thing.
|
|||
What looks to a human like a variable without a name is to the compiler a statement consisting of a temporary that immediately goes out of scope.
|
||||
To avoid unpleasant surprises.
|
||||
|
||||
###### Example, bad
|
||||
##### Example, bad
|
||||
|
||||
void f()
|
||||
{
|
||||
|
@ -16857,7 +16857,7 @@ You can't partially specialize a function template per language rules. You can f
|
|||
|
||||
If you intend for a class to match a concept, verifying that early saves users pain.
|
||||
|
||||
###### Example
|
||||
##### Example
|
||||
|
||||
class X {
|
||||
X() = delete;
|
||||
|
@ -16873,7 +16873,7 @@ Somewhere, possibly in an implementation file, let the compiler check the desire
|
|||
static_assert(Copyable<X>); // error: we forgot to define X's move constructor
|
||||
|
||||
|
||||
###### Enforcement
|
||||
##### Enforcement
|
||||
|
||||
Not feasible.
|
||||
|
||||
|
@ -17803,7 +17803,7 @@ and the `reserve(128)` is probably not worthwhile.
|
|||
Errors are typically best handled as soon as possible.
|
||||
If input isn't validated, every function must be written to cope with bad data (and that is not practical).
|
||||
|
||||
###### Example
|
||||
##### Example
|
||||
|
||||
???
|
||||
|
||||
|
@ -19528,7 +19528,7 @@ We value well-placed whitespace as a significant help for readability. Just don'
|
|||
|
||||
Readability.
|
||||
|
||||
###### Example
|
||||
##### Example
|
||||
|
||||
Use digit separators to avoid long strings of digits
|
||||
|
||||
|
@ -19536,7 +19536,7 @@ Use digit separators to avoid long strings of digits
|
|||
auto q2 = 0b0000'1111'0000'0000;
|
||||
auto ss_number = 123'456'7890;
|
||||
|
||||
###### Example
|
||||
##### Example
|
||||
|
||||
Use literal suffixes where clarification is needed
|
||||
|
||||
|
@ -19544,13 +19544,13 @@ Use literal suffixes where clarification is needed
|
|||
auto world = "world"; // a C-style string
|
||||
auto interval = 100ms; // using <chrono>
|
||||
|
||||
###### Note
|
||||
##### Note
|
||||
|
||||
Literals should not be sprinkled all over the code as ["magic constants"](#Res-magic),
|
||||
but it is still a good idea to make them readable where they are defined.
|
||||
It is easy to make a typo in a long string of integers.
|
||||
|
||||
###### Enforcement
|
||||
##### Enforcement
|
||||
|
||||
Flag long digit sequences. The trouble is to define "long"; maybe 7.
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user