Skip to content

Commit

Permalink
Code doc improvements
Browse files Browse the repository at this point in the history
Thanks to Sven Mortensen.
  • Loading branch information
josephwright committed Aug 6, 2023
1 parent 74a9198 commit 95404fa
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 14 deletions.
2 changes: 1 addition & 1 deletion siunitx-angle.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
% may be given as expressions. The \meta{angle} should be a number as understood
% by \cs{siunitx_format_number:nN}, with no uncertainty, exponent or imaginary
% part. The unit symbols for degrees, minutes and seconds are |\degree|,
% |\arcminute| and |\arcsecond|, respectively
% |\arcminute| and |\arcsecond|, respectively.
% \end{function}
%
% \subsection{Key--value options}
Expand Down
4 changes: 2 additions & 2 deletions siunitx-compound.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
% \end{syntax}
% Prints a set of numbers in the \meta{entries}, each of which should
% be given as a \meta{balanced text}. Unlike \cs{siunitx_number_list:nn}, this
% function may semantically take any form
% function may semantically take any form.
% \end{function}
%
% \begin{function}{\siunitx_compound_quantity:nn}
Expand All @@ -75,7 +75,7 @@
% \end{syntax}
% Prints a set of quantities in the \meta{entries}, each of which should
% be given as a \meta{balanced text}. Unlike \cs{siunitx_quantity_list:nn}, this
% function may semantically take any form
% function may semantically take any form.
% \end{function}
%
% \begin{function}{\siunitx_number_list:nn}
Expand Down
2 changes: 2 additions & 0 deletions siunitx-emulation.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
%
% \begin{documentation}
%
% This sub-module exposes no API.
%
% \end{documentation}
%
% \begin{implementation}
Expand Down
6 changes: 3 additions & 3 deletions siunitx-number.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
% \begin{itemize}
% \item[\texttt{S}] A single symmetrical uncertainty (\foreign{e.g.}~a
% statistical standard uncertainty). The data item here is a single
% value representing the uncertainty in the least-significant digits
% value representing the uncertainty in the least-significant digits.
% \item[\texttt{A}] A single unsymmetrical uncertainty. The data item here
% contains two brace groups, each using the same least-significant digit
% approach as the \texttt{S} type. The positive component is given first
Expand Down Expand Up @@ -537,7 +537,7 @@
% setting |down| means that the value will be rounded toward zero. The
% setting |nearest| means that the value will be rounded to the nearest
% (either up or down), taking account of the setting of |round-half|.
% The standard setting is |nearest|
% The standard setting is |nearest|.
% \end{function}
%
% \begin{function}{round-half}
Expand Down Expand Up @@ -663,7 +663,7 @@
% the setting |down| means that the uncertainty will be rounded toward zero.
% The setting |nearest| means that the uncertainty will be rounded to the
% nearest (either up or down), taking account of the setting of |round-half|.
% The standard setting is |nearest|
% The standard setting is |nearest|.
% \end{function}
%
% \begin{function}{uncertainty-separator}
Expand Down
29 changes: 22 additions & 7 deletions siunitx-print.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,31 @@
% take place in text or math mode.
%
% The printing routines assume that normal \LaTeXe{} font selection commands
% are available, in particular \cs{bfseries}, \cs{mathrm}, \cs{mathversion},
% \cs{fontfamily}, \cs{fontseries} and \cs{fontshape}, \cs{familydefault},
% \cs{seriesdefault}, \cs{shapedefault} and \cs{selectfont}.
% It also requires the standard
% \LaTeXe{} kernel commands \cs{ensuremath}, \cs{mbox}, \cs{textsubscript} and
% \cs{textsuperscript} for printing in text mode. The following packages are
% are available, in particular
% \begin{itemize}
% \item \cs{bfseries},
% \item \cs{mathrm},
% \item \cs{mathversion},
% \item \cs{fontfamily},
% \item \cs{fontseries},
% \item \cs{fontshape},
% \item \cs{familydefault},
% \item \cs{seriesdefault},
% \item \cs{shapedefault} and
% \item \cs{selectfont}.
% \end{itemize}
% It also requires the standard \LaTeXe{} kernel commands
% \begin{itemize}
% \item \cs{ensuremath},
% \item \cs{mbox},
% \item \cs{textsubscript} and
% \item \cs{textsuperscript}
% \end{itemize}
% for printing in text mode. The following packages are
% also required to provide the functionality detailed.
% \begin{itemize}
% \item \pkg{color}: support for color using \cs{textcolor}
% \item \pkg{textcomp}: \cs{textminus}, \cs{textpm} \cs{texttimes} and
% \item \pkg{textcomp}: \cs{textminus}, \cs{textpm}, \item \cs{texttimes} and
% \cs{textcenteredperiod} for printing in text mode
% \item \pkg{amstext}: the \cs{text} command for printing in text mode
% \end{itemize}
Expand Down
2 changes: 2 additions & 0 deletions siunitx-symbol.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
%
% \begin{documentation}
%
% This sub-module exposes no API.
%
% \end{documentation}
%
% \begin{implementation}
Expand Down
2 changes: 1 addition & 1 deletion siunitx-unit.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@
% |power-half-as-sqrt| = |true|\verb"|"|false|
% \end{syntax}
% Used to determine whether a power of exactly half is converted to
% \cs{sqrt} in the output. The standard setting is |false|
% \cs{sqrt} in the output. The standard setting is |false|.
% \end{function}
%
% \begin{function}{qualifier-mode}
Expand Down

0 comments on commit 95404fa

Please sign in to comment.