Fixes small formatting inconsistencies (#60)

Adds missing meta text (italics), unifies formatting and fixes some typos.

Author: vulder

functions/user-defined-literals.md

@@ -1,4 +1,5 @@
 # Functions: user-defined literals
+
 _Skeleton instructions are typeset in italic text._
 
 ## Overview
@@ -43,8 +44,10 @@ _Very brief introduction to the topic._
 
 ## Foundational: Using UDLs
 
+
 ### Background/Required Knowledge
 
+
 A student:
 * knows how to form numeric literals, e.g., `1.5f` means a `float` of value `1.5`.
 * is familiar with the major C++ types:
@@ -58,7 +61,7 @@ A student:
 
 ### Student outcomes
 
-_A list of things “a student should be able to” after the curriculum._
+_A list of things "a student should be able to" after the curriculum._
 _The next word should be an action word and testable in an exam._
 _Max 5 items._
 
@@ -91,20 +94,33 @@ _This section lists important details for each point._
 
 ## Main: implementing UDLs
 
-### Background/required knowledge
+
+### Background/Required Knowledge
+
 
 * All of the above.
 
 ### Student outcomes
 
+_A list of things "a student should be able to" after the curriculum._
+_The next word should be an action word and testable in an exam._
+_Max 5 items._
+
 A student should be able to:
 
 1. write a UDL operator of their own.
 2. separate unrelated UDLs into distinct namespaces.
 
 ### Caveats
+
+_This section mentions subtle points to understand, like anything resulting in
+implementation-defined, unspecified, or undefined behavior._
+
 No caveats at present.
 ### Points to cover
+
+_This section lists important details for each point._
+
 No caveats at present.
 ## Advanced
 

object-model/copy-semantics.md

@@ -1,4 +1,5 @@
 # C++ object model: copy semantics
+
 _Skeleton instructions are typeset in italic text._
 
 ## Overview
@@ -40,8 +41,10 @@ Explains when and how objects are copied.
 
 ## Foundational: How and when are copies made
 
+
 ### Background/Required Knowledge
 
+
 A student is able to:
 * explain what a C++ type is?               [[C++ object model: types]][1]
 * explain what an object is?                [[C++ object model: objects]][2], [[C++ object model: constant objects]][3]
@@ -88,8 +91,10 @@ _This section lists important details for each point._
 
 ## Main: Implementing user-defined copy operations
 
+
 ### Background/Required Knowledge
 
+
 A student is able to:
 * identify special member functions       [[C++ object model: special member functions]][5]
 
@@ -132,8 +137,8 @@ _This section lists important details for each point._
 
 ## Advanced
 
-_These are not expected to be covered but provide guidance where one can
-continue to investigate this topic in more depth._
+_These are important topics that are not expected to be covered but provide
+guidance where one can continue to investigate this topic in more depth._
 
 When can copies be elided and when does the standard guarantee copy elision.
 References:

skeleton.md

@@ -43,7 +43,7 @@ A student:
 
 ### Student outcomes
 
-_A list of things “a student should be able to” after the curriculum._
+_A list of things "a student should be able to" after the curriculum._
 _The next word should be an action word and testable in an exam._
 _Max 5 items._
 
@@ -66,7 +66,7 @@ _This section lists important details for each point._
 
 ## Main: implementing *
 
-### Background/required knowledge
+### Background/Required Knowledge
 
 * All of the above.
 

topic_updater.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """
 Small tool for generating and fixing teaching topics.
 
@@ -196,8 +197,8 @@ def update_topic_meta_text(self, topic_file: tp.TextIO) -> tp.List[str]:
         return updated_topic_lines
 
     def __process_existing_topic_content(
-        self, topic_file: tp.TextIO,
-        skeleton_headings_iter: tp.Iterator[SectionHeading]
+            self, topic_file: tp.TextIO,
+            skeleton_headings_iter: tp.Iterator[SectionHeading]
     ) -> tp.List[str]:
         """
         This method checks that all heading related lines in the topic file
@@ -262,7 +263,7 @@ def __process_existing_topic_content(
 
     @staticmethod
     def __get_remaining_section_headings(
-        skeleton_headings_iter: tp.Iterator[SectionHeading]
+            skeleton_headings_iter: tp.Iterator[SectionHeading]
     ) -> tp.List[str]:
         """
         Returns a list of all `SectionHeading`s that are still missing and