Skip to content

Commit 9dc2dad

Browse files
committed
Unified header style
1 parent 0f0c478 commit 9dc2dad

File tree

14 files changed

+43
-33
lines changed

14 files changed

+43
-33
lines changed

docs/make.jl

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,48 +22,49 @@ installation = [
2222
"Julia" => "./installation/julia.md",
2323
"Visual Studio Code" => "./installation/vscode.md",
2424
"Git" => "./installation/git.md",
25-
"Quick Start Guide" => "./installation/tutorial.md",
25+
"Quickstart guide" => "./installation/tutorial.md",
2626
]
2727

2828
lecture_01 = [
2929
"Variables" => "./lecture_01/variables.md",
30-
"Elementary Functions" => "./lecture_01/operators.md",
30+
"Elementary functions" => "./lecture_01/operators.md",
3131
"Strings" => "./lecture_01/strings.md",
3232
"Arrays" => "./lecture_01/arrays.md",
33-
"Data Structures" => "./lecture_01/data_structures.md",
33+
"Data structures" => "./lecture_01/data_structures.md",
3434
]
3535

3636
lecture_02 = [
37-
"Conditional Evaluations" => "./lecture_02/conditions.md",
38-
"Loops and Iterators" => "./lecture_02/loops.md",
39-
"Soft Local Scope" => "./lecture_02/scope.md",
37+
"Conditional evaluations" => "./lecture_02/conditions.md",
38+
"Loops and iterators" => "./lecture_02/loops.md",
39+
"Soft local scope" => "./lecture_02/scope.md",
4040
"Exercises" => "./lecture_02/exercises.md",
4141
]
4242

4343
lecture_03 = [
4444
"Functions" => "./lecture_03/functions.md",
4545
"Methods" => "./lecture_03/methods.md",
46-
"Scope of Variables" => "./lecture_03/scope.md",
47-
"Exception Handling" => "./lecture_03/exceptions.md",
46+
"Scope of variables" => "./lecture_03/scope.md",
47+
"Exception handling" => "./lecture_03/exceptions.md",
4848
"Exercises" => "./lecture_03/exercises.md",
4949
]
5050

5151
lecture_04 = [
52-
"Standard Library" => "./lecture_04/standardlibrary.md",
52+
"Standard library" => "./lecture_04/standardlibrary.md",
5353
"Plots.jl" => "./lecture_04/Plots.md",
5454
"DataFrames.jl" => "./lecture_04/DataFrames.md",
55-
"Other Useful Packages" => "./lecture_04/otherpackages.md",
55+
"Other useful packages" => "./lecture_04/otherpackages.md",
56+
"Interaction with other languages" => "./lecture_04/interaction.md",
5657
]
5758

5859
lecture_05 = [
5960
"Abstract and composit types" => "./lecture_05/compositetypes.md",
60-
"Generic Programming" => "./lecture_05/currencies.md",
61+
"Generic programming" => "./lecture_05/currencies.md",
6162
]
6263

6364
lecture_06 = [
64-
"Modules" => "./lecture_06/modules.md",
65-
"Package Manager" => "./lecture_06/pkg.md",
66-
"Package Development" => "./lecture_06/develop.md",
65+
"Files and modules" => "./lecture_06/modules.md",
66+
"Package manager" => "./lecture_06/pkg.md",
67+
"Package development" => "./lecture_06/develop.md",
6768
]
6869

6970
finalproject = joinpath.("./final_project/", [
@@ -127,7 +128,7 @@ makedocs(;
127128
"3: Functions and methods" => lecture_03,
128129
"4: Packages" => lecture_04,
129130
"5: Type system and generic programming" => lecture_05,
130-
"6: Modules and packages" => lecture_06,
131+
"6: Code organization" => lecture_06,
131132
"Course requirements" => finalproject,
132133
"7: Optimization" => lecture_07,
133134
"8: Regression and classification" => lecture_08,

docs/src/installation/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The new file will open in the editor to the right of the File Explorer sidebar.
2626

2727
![](tutorial_6.png)
2828

29-
## Initialize Git Repository
29+
## Initialize Git repository
3030

3131
Now that we have created a new project, it is time to initialize the git repository to track the project's changes. Go to the `Source Control` bar by pressing the appropriate button in the activity bar. Then press the `Initialize Repository` button, which will create a new Git repository in the project folder.
3232

docs/src/lecture_01/data_structures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ julia> a, b, c, d = t
7979
</p></details>
8080
```
8181

82-
## Named Tuples
82+
## Named tuples
8383

8484
Named tuples are similar to tuples, i.e., a named tuple is immutable, ordered, fixed-sized group of elements. The only difference is that each element consists of a name (identifier) and a value. Named tuples are created by the following syntax:
8585

docs/src/lecture_01/operators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ julia> round(x; sigdigits = 3)
511511
</p></details>
512512
```
513513

514-
## Numerical Conversions
514+
## Numerical conversions
515515

516516
The previous section showed that numerical conversions could be done by using rounding functions with a specified type of output variable. This works only for converting floating-point numbers to integers. Julia also provides a more general way of how to perform conversions between different (not only numerical) types: notation `T(x)` or `convert(T,x)` converts `x` to a value of type `T`.
517517
- If `T` is a floating-point type, the result is the nearest representable value, which could be positive or negative infinity

docs/src/lecture_01/variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ There are many types in Julia. In fact, every object in Julia has its type. As a
9898

9999
All types shown in blue are abstract types, i.e., it is impossible to create an instance of such a type. Abstract types are useful for creating logical type hierarchy. Types highlighted in green are concrete types. In many cases, it is useful to have the choice to choose which type to use. As an example, we can see floating-point numbers. There are four concrete types for floating-point numbers. If we want to maximize the precision of some calculations, we can use `BigFloat`. Using `BigFloat` increases precision but also increases computational time. On the other hand, if we want to speed up the code, we can use the type with lower precision, such as `Float32`. However, in most cases, the user does not have to take care of types and use the default type.
100100

101-
## Variable Names
101+
## Variable names
102102

103103
Julia provides an extremely flexible system for naming variables. Variable names are case-sensitive and have no semantic meaning, i.e., the language will not treat variables differently based on their names.
104104

docs/src/lecture_02/scope.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Soft Local Scope
1+
# Soft local scope
22

3-
The scope of a variable is the region of a code where the variable is visible. There are two main types of scopes in Julia: **global** and **local**, and we will discuss it [later](@ref Scope-of-Variables). In this section, we will only focus on loops.
3+
The scope of a variable is the region of a code where the variable is visible. There are two main types of scopes in Julia: **global** and **local**, and we will discuss it [later](@ref Scope-of-variables). In this section, we will only focus on loops.
44

55
Every variable created inside a loop is local, i.e., it is possible to use it only inside the loop.
66

docs/src/lecture_03/exceptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Exception Handling
1+
# Exception handling
22

33
Unexpected behaviour may often occur during running code, which may lead to the situation that some function cannot return a reasonable value. Such behaviour should be handled by either terminating the program with a proper diagnostic error message or allowing that code to take appropriate action.
44

docs/src/lecture_03/functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,7 @@ open("outfile", "w") do io
781781
end
782782
```
783783

784-
## Dot Syntax for Vectorizing Functions
784+
## Dot syntax for vectorizing functions
785785

786786
In technical-computing languages, it is common to have *vectorized* versions of functions. Consider that we have a function `f(x)`. Its vectorized version is a function that applies function `f` to each element of an array `A` and returns a new array `f(A)`. Such functions are beneficial in languages, where loops are slow and vectorized versions of functions are written in a low-level language (C, Fortran,...) and are much faster.
787787

docs/src/lecture_03/methods.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -439,9 +439,7 @@ nothing # hide
439439
</p></details>
440440
```
441441

442-
443-
444-
## Method Ambiguities
442+
## Method ambiguities
445443

446444
It is possible to define a set of function methods with no most specific method applicable to some combinations of arguments.
447445

docs/src/lecture_03/scope.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
# Scope of Variables
1+
# Scope of variables
32

43
The scope of a variable is the region of a code where the variable is visible. There are two main scopes in Julia: **global** and **local**. The global scope can contain multiple local scope blocks. Local scope blocks can be nested. There is also a distinction in Julia between constructs which introduce a *hard scope* and those which only introduce a *soft scope*. This affects whether shadowing a global variable by the same name is allowed.
54

0 commit comments

Comments
 (0)