Skip to content

Commit 5aff11c

Browse files
authored
Update headers.md
feeling of small-group was to omit advanced section, as each advanced topic seemed more relevant to a different module
1 parent 7fa5628 commit 5aff11c

File tree

1 file changed

+1
-35
lines changed

1 file changed

+1
-35
lines changed

sources/modules/compilation-model/headers.md

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Foundational Including code through standard library headers
1616
Main Write headers to support separate compilation and code
1717
organization
1818

19-
Advanced --- (inlining? templates? hygiene, such as using namespace?)
19+
Advanced ---
2020

2121
------------------------------------------------------------------------
2222

@@ -98,43 +98,9 @@ A student should be able to:
9898
* Reusing the same include guards may cause confusion. Naming conventions based on file paths can help
9999
* Accidentally putting a definition in a header file may or may not introduce undefined behavior
100100
* Circular dependencies can cause confusion. Care should be taken in identifying such
101-
*
102101

103102
#### Points to cover
104103

105104
* Angular bracket inclusion goes to the system/compiler path
106105
* Double quotes inclusion uses just relative paths
107106

108-
### Advanced
109-
110-
_These are important topics that are not expected to be covered but provide
111-
guidance where one can continue to investigate this topic in more depth._
112-
113-
Header-only libraries?
114-
Templates in headers?
115-
Classes in headers?
116-
Macros in headers?
117-
Modules as replacement?
118-
Issues with specifying default arguments in headers?
119-
120-
121-
#### Background/Required Knowledge
122-
123-
* All of the above
124-
125-
#### Student outcomes
126-
127-
A student should be able to:
128-
129-
1. Utilize angular-bracket inclusion and compiler flags to include headers from non-standard paths
130-
2. Identify trade-offs of aggressiveness of putting declarations in a header file without known consumer
131-
132-
#### Caveats
133-
134-
_This section mentions subtle points to understand, like anything resulting in
135-
implementation-defined, unspecified, or undefined behavior._
136-
137-
#### Points to cover
138-
139-
_This section lists important details for each point._
140-

0 commit comments

Comments
 (0)