Skip to content

Commit 72cfd0a

Browse files
committed
Fix grammar and style issues in documentation
- Corrected typos (e.g. "delimitor" -> "delimiter", "a accepting" -> "an accepting", "so called" -> "so-called"). - Improved grammar and readability in multiple sections: - Rephrased awkward or unclear sentences. - Added missing articles and adjusted phrasing for clarity. - Standardized wording (e.g., "later self" -> "future self").
1 parent 9550bfb commit 72cfd0a

4 files changed

Lines changed: 15 additions & 16 deletions

File tree

docs/sections/first-program.tex

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
In most programming languages the first program people write is the so called ``Hello World'' program.
1+
In most programming languages the first program people write is the so-called ``Hello World'' program.
22

33
The main idea is to show \code{Hello World} to the user.
44

@@ -34,7 +34,7 @@ \subsubsection{The head}
3434

3535
\textbf{So: What can we see?}
3636
\begin{itemize}
37-
\item Every single statement we define has the structure:
37+
\item Each statement follows this structure:
3838
\begin{center}
3939
\code{<name> = <value>}
4040
\end{center}
@@ -56,11 +56,11 @@ \subsubsection{The head}
5656
end = HALT
5757
\end{verbatim}
5858

59-
Now to end the head and start the body we can write any number of \code{-} as a delimitor. For example something like this: \code{----}.
59+
Now to end the head and start the body we can write any number of \code{-} as a delimiter. For example something like this: \code{----}.
6060

6161
\subsubsection{The body}
6262
The body contains the state machine. This state machine is the heart of the Turing Machine.
63-
So let's visualize how the state machine should look like before we actually implement it:
63+
So let's visualize how the state machine should look before we actually implement it:
6464

6565
\begin{center}
6666
\begin{tikzpicture}[->, % makes the edges directed
@@ -163,13 +163,12 @@ \subsection{Executing the program}
163163
..., 0, 0, 0, Hello, World, 0, 0, 0, 0, ...
164164
\end{verbatim}
165165

166-
And now you have written and executed your first Tau program. Yay!
166+
You have now written and executed your first Tau program. Yay!
167167

168168
\subsection{Comments}
169-
Comments are an essential aspect of documenting the code so that other people and your later self can understand what the code does
169+
Comments are an essential aspect of documenting the code so that other people -- and your future self -- can understand what the code does
170170
if it doesn't work what the intention was.
171-
172-
In Tau there are only single line comments. They start with a \code{\#} and end with the next Line separator (\code{\textbackslash n}).
171+
In Tau there are only single line comments. They start with a \code{\#} and end with the next line separator (\code{\textbackslash n}).
173172

174173
These comments can be added anywhere and nothing inside the comment will be parsed.
175174

docs/sections/flags.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Some things are not being set up by the program, but rather before executing the program in the command line.
1+
Some settings are not configured within the program itself, but are instead specified via command-line flags before execution.
22

33
These different settings are flags that can be specified with \code{--\{name\} \{value\}}.
44

docs/sections/introduction.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ \subsubsection{How a Turing Machine works}
111111
Repeating these steps twelve times as these are mostly the same steps:
112112

113113
\begin{minipage}{0.45\textwidth}
114-
After repeating this twelve times we get to this configuration where the Turing Machine is currently
115-
in the state C and the head currently reads the value $1$. This means that the Turing Machine will now go to state H (\code{HALT}).
114+
After repeating this twelve times we get to this configuration where the Turing Machine is currently in state C,
115+
and the head reads the value $1$. This means that the Turing Machine will now go to state H (\code{HALT}).
116116
\end{minipage}
117117
\begin{minipage}{0.50\textwidth}
118118
\centering
@@ -138,7 +138,7 @@ \subsubsection{How a Turing Machine works}
138138
\par\noindent\rule{\textwidth}{0.4pt}
139139

140140
\begin{minipage}{0.45\textwidth}
141-
As the state machine is currently in a accepting state (the double circle) it will stop the Turing Machine and terminate.
141+
As the state machine is currently in an accepting state (the double circle) it will stop the Turing Machine and terminate.
142142
It will not go to the next state nor do any modifications on the tape.
143143
\end{minipage}
144144
\begin{minipage}{0.50\textwidth}

docs/sections/technical-documentation.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
The programming language Tau is a very simple language. It only implements a Turing Machine and the interface, which is the programming language.
22

33
\subsection{EBNF}
4-
This is how the language is parsed. It does not mean that everything that can be built with this EBNF syntax is also valid.
4+
This describes how the language is parsed. Not everything that can be expressed in this EBNF syntax is valid
55
It is implied that between each token there can be as much whitespace as needed.
6-
The tokens are being declared with uppercase letters. Comments are separate as they are just being skipped by the lexer.
6+
The tokens are being declared with uppercase letters. Comments are handled separately, as they are simply skipped by the lexer.
77

88
\begin{verbatim}
99
program = head, body;
@@ -45,8 +45,8 @@ \subsubsection{Head Linking}
4545
It also checks if the blank is a valid symbol.
4646

4747
\subsubsection{Body Linking}
48-
Any state can be defined in any order. This means that there can be a different state which is being
49-
referenced that will be parsed. This means that the linking is also being done after the parser finds the end
48+
Any state can be defined in any order. This means that a state can reference another state that has not yet been parsed.
49+
This means that the linking is also being done after the parser finds the end
5050
of the file.
5151

5252
The linker also needs the states to be exhaustive. This means that every single possibility is being covered.

0 commit comments

Comments
 (0)