Skip to content

Commit 89cb92c

Browse files
committed
Attempt markdown formatting of nodes and remove some alt text comments
1 parent 4f2655e commit 89cb92c

2 files changed

Lines changed: 17 additions & 17 deletions

File tree

episodes/00-setting-the-scene.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,14 @@ Skills and tools taught here, while Python-specific,
5757
are transferable to other similar tools and programming languages.
5858

5959
The course is organised into the following sections.
60-
<!--
61-
alt-tex="Course overview diagram. Arrows connect the following boxed text in order: 1) Setting up software environment 2) Verifying software correctness 3) Software development as a process 4) Collaborative development for reuse 5) Managing software over its lifetime."
62-
-->
60+
6361
```mermaid
6462
flowchart LR
65-
accDescr {Overview of sections in the lesson: setting up development environment, verifying software correctness, the process of software development & engineering, collaborative software development, managing & maintaining software}
63+
accTitle: Overview of sections in the lesson
64+
accDescr {Course overview diagram. Arrows connect the following boxed
65+
text in order: 1) Setting up software environment 2) Verifying software
66+
correctness 3) Software development as a process 4) Collaborative
67+
development for reuse 5) Managing software over its lifetime.}
6668
A(1. Setting up software environment) --> B(2. Verifying software correctness)
6769
B --> C(3. Software development as a process)
6870
C --> D(4. Collaborative development for reuse)

episodes/10-section1-intro.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,19 @@ As you get more comfortable with different tools and their alternatives,
3131
you will select the one that is right for you based on your personal preferences
3232
or based on what your collaborators are using.
3333

34-
<!--
35-
alt = "Topics on effective collaborating on code development covered in the current section: virtual development environments, version control & sharing code, writing readable code & code standards"
36-
"
37-
-->
3834
```mermaid
3935
flowchart LR
40-
accDescr {Topics on effective collaborating on code development covered in the current section: virtual development environments, version control & sharing code, writing readable code & code standards}
41-
A(1. Setting up software environment
42-
- Isolating & running code: command line, virtual environment & IDE
43-
- Version control and sharing code: Git & GitHub
44-
- Well-written & readable code: PEP8)
45-
A --> B(2. Verifying software correctness)
46-
B --> C(3. Software development as a process)
47-
C --> D(4. Collaborative development for reuse)
48-
D --> E(5. Managing software over its lifetime)
36+
accDescr {Topics on effective collaborating on code development covered in
37+
the current section: virtual development environments, version control &
38+
sharing code, writing readable code & code standards}
39+
A("`1. Setting up software environment
40+
- Isolating & running code: command line, virtual environment & IDE
41+
- Version control and sharing code: Git & GitHub
42+
- Well-written & readable code: PEP8`")
43+
A --> B(2. Verifying software correctness)
44+
B --> C(3. Software development as a process)
45+
C --> D(4. Collaborative development for reuse)
46+
D --> E(5. Managing software over its lifetime)
4947
```
5048

5149
Here is an overview of the tools we will be using.

0 commit comments

Comments
 (0)