Skip to content

Commit 061446e

Browse files
committed
chore(manual): format
Signed-off-by: Jonas Dujava <[email protected]>
1 parent 0c9ce77 commit 061446e

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

chapters/Appendix.tex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ \section{Appendix Section}%
6868
\end{remark}
6969

7070
\begin{example}[Equation Numbering and Referencing]
71-
As was mentioned already in \Cref{sec:Document Structure}, equations share numbering with \emph{structure environments}. For example, the equation
71+
As was mentioned already in \Cref{sec:Document Structure}, equations share numbering with \emph{structure environments}.
72+
For example, the equation
7273
\begin{equation} \label{eq:appendix_equation}
7374
\phi^{*}\bm{g}' \overset{!}{=} \Omega^{2}\bm{g} \equiv \E*^{2\omega}\bm{g}
7475
\end{equation}

chapters/Design.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ \chapter{Design Principles} \label{ch:Design}
88
\mspace{12mu} \text{and} \mspace{10mu}
99
\parbox[c]{7em}{\centering implemented certain features}
1010
\quad\longleadsto{}\quad
11-
\parbox[c]{10em}{\centering recognized\\\textcolor{gray}{at first subconscious} overarching principles}~.
11+
\parbox[c]{10em}{\centering recognized \\\textcolor{gray}{at first subconscious} overarching principles}~.
1212
\]
1313
Anyway, here they are.
1414
\begin{definition}[Design Principles] \label{def:Design Principles}
@@ -20,7 +20,8 @@ \chapter{Design Principles} \label{ch:Design}
2020
\end{itemize}
2121
\end{definition}
2222
\begin{remark}[Common Goal, Alternative Definition via Antiprinciples]
23-
There is also an alternative point of view. The common goal of \Nref*{def:Design Principles} is to minimize the following \emph{Antiprinciples}:
23+
There is also an alternative point of view.
24+
The common goal of \Nref*{def:Design Principles} is to minimize the following \emph{Antiprinciples}:
2425
\begin{itemize}
2526
\item We should be concise, and that means fewer pages, the better.
2627
Long blocks of text without noticeable space between paragraphs are preferred (the reader should go on a walk to have some breathing spacetime).
@@ -32,8 +33,7 @@ \chapter{Design Principles} \label{ch:Design}
3233
Each of these principles is somehow reflected in the design choices and features included (or omitted) in \TeXtured{}, see \Cref{ch:Features} for more details.
3334

3435
\begin{remark}[Disclaimer]
35-
The following is at places highly opinionated, and not applicable to all
36-
scenarios and use-cases.
36+
The following is at places highly opinionated, and not applicable to all scenarios and use-cases.
3737
I tried to describe my reasons for specific design choices, with which you can certainly disagree.
3838
I hope that at least it can provoke more people \emph{(especially you!)} to contemplate about document creation, ideally resulting in production of documents with overall better quality.
3939
\end{remark}

chapters/Features.tex

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,7 @@ \subsection{\texorpdfstring{Micro-\!Typography}{Micro-Typography}}%
234234

235235
Following quote from \package{microtype} documentation nicely explains what it is about:
236236
\begin{displayquote}
237-
Micro-typography is the art of enhancing the appearance and readability of a
238-
document while exhibiting a minimum degree of visual obtrusion.
237+
Micro-typography is the art of enhancing the appearance and readability of a document while exhibiting a minimum degree of visual obtrusion.
239238
It is concerned with what happens between or at the margins of characters, words or lines.
240239
Whereas the macro-typographical aspects of a document (i.e., its layout) are clearly visible even to the untrained eye, micro-typographical refinements should ideally not even be recognizable.
241240
That is, you may think that a document looks beautiful, but you might not be able to tell exactly why: good micro-typographic practice tries to reduce all potential irritations that might disturb a reader.
@@ -260,8 +259,7 @@ \subsection{Structure Environments}%
260259
Implemented mostly \package{tcolorbox} package and \package{keytheorems} (modern key--value interface for \package{amsthm}).
261260

262261
\begin{remark}[Default Environments]
263-
There are predefined boxed \enquote{theorem-like} environments for \textsf{Definition}, \textsf{Theorem}, \textsf{Lemma}, \textsf{Corollary}, \textsf{Proposition},
264-
and non-boxed \enquote{remark-like} environments for \textsf{Remark}, \textsf{Proof}, \textsf{Example}, \textsf{Derivation}, \textsf{Calculation}, \textsf{Idea}, and \textsf{Tip} (these have at least a mark indicating the end of the environment).
262+
There are predefined boxed \enquote{theorem-like} environments for \textsf{Definition}, \textsf{Theorem}, \textsf{Lemma}, \textsf{Corollary}, \textsf{Proposition}, and non-boxed \enquote{remark-like} environments for \textsf{Remark}, \textsf{Proof}, \textsf{Example}, \textsf{Derivation}, \textsf{Calculation}, \textsf{Idea}, and \textsf{Tip} (these have at least a mark indicating the end of the environment).
265263

266264
Names of the corresponding environments are lowercase, for example \texttt{definition}, \texttt{remark}, and so on.
267265
They also accept an optional argument for a short description.
@@ -437,7 +435,8 @@ \subsection{Math-Related Tweaks --- \texorpdfstring{\rmfamily\(\E^{\I\pi}\)}{exp
437435
\vspace{1ex}
438436
Following practice is highly recommended.
439437
\begin{tip}[Define Your Own Math Macros]
440-
Frequently define macros for notation used more than once. Advantages are for example:
438+
Frequently define macros for notation used more than once.
439+
Advantages are for example:
441440
\begin{itemize}
442441
\item Code is easier to read/write, since it is more \enquote{semantic}.
443442
\item To tweak notation, you only need to change it in one place.

0 commit comments

Comments
 (0)