Skip to content

Commit 729f803

Browse files
committed
Revert "Adapt teaching modules to new format"
This reverts commit dbf805d.
1 parent e26a55d commit 729f803

File tree

5 files changed

+3
-66
lines changed

5 files changed

+3
-66
lines changed
Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
# Compile-time programming: concepts
22

3-
_Skeleton descriptions are typeset in italic text,_
4-
_so please don't remove these descriptions when editing the topic._
5-
63
This topic is currently under construction and will soon be filled with information :)
Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
# Compile-time programming: Function Templates
22

3-
_Skeleton descriptions are typeset in italic text,_
4-
_so please don't remove these descriptions when editing the topic._
5-
63
This topic is currently under construction and will soon be filled with information :)

sources/modules/compile-time-programming/requires-expressions.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
## Module name: Requires Expressions {#req-expr}
2-
32
_Skeleton descriptions are typeset in italic text,_
43
_so please don't remove these descriptions when editing the topic._
54

65
### Overview
76

8-
_Provides a short natural language abstract of the module’s contents._
9-
_Specifies the different levels of teaching._
10-
117
-------------------------------------------------------------------------
128
Level Objectives
139
------------------ ------------------------------------------------------
@@ -22,17 +18,12 @@ Advanced ---
2218

2319
### Motivation
2420

25-
_Why is this important?_
26-
_Why do we want to learn/teach this topic?_
27-
2821
Requires-expressions allow a developer to perform compile-time evaluation
2922
on the validity of other expressions. These are fundamental to the ability
3023
to write concepts. [[Compile-time programming: concepts]][1]
3124

3225
## Topic introduction
3326

34-
_Very brief introduction to the topic._
35-
3627
Requires-expressions are compile-time predicates which evaluate to true
3728
when their specified set of expressions are all valid for a given set of
3829
inputs.
@@ -52,10 +43,6 @@ It is helpful if:
5243

5344
#### Student outcomes
5445

55-
_A list of things "a student should be able to" after the curriculum._
56-
_The next word should be an action word and testable in an exam._
57-
_Max 5 items._
58-
5946
A student should be able to:
6047

6148
1. Write a simple-requirement to assert the validity of an expression
@@ -66,9 +53,6 @@ A student should be able to:
6653

6754
#### Caveats
6855

69-
_This section mentions subtle points to understand, like anything resulting in
70-
implementation-defined, unspecified, or undefined behavior._
71-
7256
To require that expressions, which evaluate to a boolean value
7357
like `sizeof(t) == 4`, evaluate to `true` a nested-requirement is needed
7458
(e.g., `requires sizeof(t) == 4;`). Omitting the `requires` results in a
@@ -77,8 +61,6 @@ not on the result of the operation.
7761

7862
#### Points to cover
7963

80-
_This section lists important details for each point._
81-
8264
* All requires-expression requirements terminate with a semicolon.
8365
* simple-requirements are used to check that an expression is well-formed.
8466
* nested-requirements are introduced with `requires` and primarily used to check the result of an expression computable by the compiler, including concepts or other requires-expressions.
@@ -89,7 +71,7 @@ _This section lists important details for each point._
8971

9072
### Main: Advanced requirements {#req-expr-intermediate}
9173

92-
#### Background/Required Knowledge
74+
#### Background/required knowledge
9375

9476
* All of the above.
9577
* Knowledge of `noexcept`
@@ -100,24 +82,15 @@ A student is able to:
10082

10183
#### Student outcomes
10284

103-
_A list of things "a student should be able to" after the curriculum._
104-
_The next word should be an action word and testable in an exam._
105-
_Max 5 items._
106-
10785
A student should be able to:
10886

10987
1. Write compound-requirements which test the `noexcept`ness of an expression.
11088
2. Use a concept as the target of a compound-requirement.
11189

11290
#### Caveats
11391

114-
_This section mentions subtle points to understand, like anything resulting in
115-
implementation-defined, unspecified, or undefined behavior._
116-
11792
#### Points to cover
11893

119-
_This section lists important details for each point._
120-
12194
* Compound-requirements allow the optional ability to test whether an expression is marked as `noexcept`, by using a trailing `noexcept` keyword.
12295

12396
```cpp

sources/modules/functions/defaulted-parameters.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
## Functions: default argument {#func-args}
2-
32
_Skeleton descriptions are typeset in italic text,_
43
_so please don't remove these descriptions when editing the topic._
54

65
### Overview
76

8-
_Provides a short natural language abstract of the module’s contents._
9-
_Specifies the different levels of teaching._
10-
117
Functions in C++ may be overloaded with different numbers and types of
128
parameters. It may be of value to specify default arguments for some number
139
of parameters, to allow a caller to avoid specifying arguments that
@@ -27,17 +23,12 @@ Advanced refinement of default arguments through multiple
2723

2824
### Motivation
2925

30-
_Why is this important?_
31-
_Why do we want to learn/teach this topic?_
32-
3326
Default arguments allow the omission of arguments with obvious or common
3427
values. Also may be utilized to extend an existing function signature
3528
without forcing changes to existing calling code.
3629

3730
### Topic introduction
3831

39-
_Very brief introduction to the topic._
40-
4132
Explain how default arguments work and how to define them.
4233

4334
### Foundational: Using and defining functions with default arguments {#func-args-basic}
@@ -53,10 +44,6 @@ A student is able to:
5344

5445
#### Student outcomes
5546

56-
_A list of things "a student should be able to" after the curriculum._
57-
_The next word should be an action word and testable in an exam._
58-
_Max 5 items._
59-
6047
A student should be able to:
6148

6249
1. Call to a function with a default argument with or without that argument specified
@@ -66,50 +53,33 @@ A student should be able to:
6653

6754
#### Caveats
6855

69-
_This section mentions subtle points to understand, like anything resulting in
70-
implementation-defined, unspecified, or undefined behavior._
71-
7256
* When no forward-declaration exists, the definition serves as the declaration
7357
* When multiple declarations exist, only one may specify the default for any particular parameter, but multiple declarations may specify the defaults for different parameters.
7458
* Additional default values may be specified for other parameters in repeat declarations
7559
* Calling an overloaded function with fewer arguments may be ambiguous with regard to an overload with default arguments
7660

7761
#### Points to cover
7862

79-
_This section lists important details for each point._
80-
8163
* Default value may only be specified once for each parameter among all declarations
8264
* Default values must start from the rightmost parameter and continue leftward without gaps
8365
* Considerations of when to use default arguments vs overload set
8466

8567
### Main: implementing * {#func-args-intermediate}
8668

87-
#### Background/Required Knowledge
69+
#### Background/required knowledge
8870

8971
* All of the above.
9072

9173
#### Student outcomes
9274

93-
_A list of things "a student should be able to" after the curriculum._
94-
_The next word should be an action word and testable in an exam._
95-
_Max 5 items._
96-
9775
A student should be able to:
9876

9977
#### Caveats
10078

101-
_This section mentions subtle points to understand, like anything resulting in
102-
implementation-defined, unspecified, or undefined behavior._
103-
10479
#### Points to cover
10580

106-
_This section lists important details for each point._
107-
10881
### Advanced {#func-args-advanced}
10982

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-
11383
Subsequent redeclarations of the same function may add default argument
11484
values, which are then usable by callers.
11585
Though a single parameter cannot be given a default argument twice in the same

sources/modules/object-model/special-member-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## C++ object model: special member functions
1+
# C++ object model: special member functions
22

33
_Skeleton descriptions are typeset in italic text,_
44
_so please don't remove these descriptions when editing the topic._

0 commit comments

Comments
 (0)