Skip to content

Commit 32c65e5

Browse files
authored
Apply suggestions from code review
1 parent bf04222 commit 32c65e5

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

sources/modules/compilation-model/headers.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Module name: Headers
1+
## C++ compilation model: Headers {#headers}
22

33
_Skeleton descriptions are typeset in italic text,_
44
_so please don't remove these descriptions when editing the topic._
@@ -38,7 +38,7 @@ The contents of header files are injected into a source file to allow
3838
multiple distinct source files to share a single source of common
3939
declarations.
4040

41-
### Foundational: Including code through standard library headers
41+
### Foundational: Including code through standard library headers {#headers-found}
4242

4343
#### Background/Required Knowledge
4444

@@ -55,13 +55,15 @@ _Max 5 items._
5555

5656
A student should be able to:
5757

58-
1. Include common standard library headers to get access to standard library features
58+
1. include common standard library headers to get access to standard library features
5959

6060
#### Caveats
6161

6262
_This section mentions subtle points to understand, like anything resulting in
6363
implementation-defined, unspecified, or undefined behavior._
6464

65+
* The include directly actually copies the header file into the file it is included in.
66+
6567
#### Points to cover
6668

6769
_This section lists important details for each point._
@@ -71,7 +73,7 @@ _This section lists important details for each point._
7173
* Include links to reference materials for finding out what headers are used for various feature sets
7274
* When using standard library facilities, can either use `using std::vector; vector<int> v;`, or `std::vector<int> v;`, or `using namespace std; vector<int> v;`, though modern practice strongly discourages invoking `using namespace std;`
7375

74-
### Main: Organizing function and class declarations for reuse
76+
### Main: Organizing function and class declarations for reuse {#headers-main}
7577

7678
_Description: Write headers to support separate compilation and code organization_
7779

@@ -86,11 +88,11 @@ _Description: Write headers to support separate compilation and code organizatio
8688

8789
A student should be able to:
8890

89-
1. Create a declaration for an existing function, placed in a separate file
90-
2. Utilize double-quote inclusion to include a header from the same directory
91-
3. Utilize angular-bracket inclusion to include a header from standard library
92-
4. Explain the meaning of the one-definition rule and how it applies to headers
93-
5. Protect a header with include guards and explain why they are necessary
91+
1. create a declaration for an existing function, placed in a separate file
92+
2. utilize double-quote inclusion to include a header from the same directory
93+
3. utilize angular-bracket inclusion to include a header from standard library
94+
4. explain the meaning of the one-definition rule and how it applies to headers
95+
5. protect a header with include guards and explain why they are necessary
9496

9597
#### Caveats
9698

0 commit comments

Comments
 (0)