Permalink
Browse files

Make name markers typographically less crazy

Thanks to Paul Whittaker for suggestions and encouragement.
  • Loading branch information...
1 parent 85dc78b commit 5cbb6d8ce18968667ed6ae56383179fb8fb9ddf3 @trebb committed Oct 28, 2011
View
713 TAGS

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -1,4 +1,4 @@
-% Copyright (C) 2008, 2009, 2010 Bert Burgemeister
+% Copyright (C) 2008, 2009, 2010, 2011 Bert Burgemeister
%
% Permission is granted to copy, distribute and/or modify this
% document under the terms of the GNU Free Documentation License,
@@ -92,12 +92,12 @@ \subsection{Array Functions}
\IT{(\FU*{ARRAY-TOTAL-SIZE} \VAR{array})}
{
- \retval{Number of elements} in \VAR{array}.
+ \retval{Number of elements} in \VAR{array}.
}
- \IT{(\FU*{ARRAY-RANK} \VAR{array})}
- {
- \retval{Number of dimensions} of \VAR{array}.
+ \IT{(\FU*{ARRAY-RANK} \VAR{array})}
+ {
+ \retval{Number of dimensions} of \VAR{array}.
}
\IT{(\FU*{ARRAY-DISPLACEMENT} \VAR{array})}
@@ -174,7 +174,7 @@ \subsection{Vector Functions}
\IT{(\FU*{SVREF} \VAR{vector} \VAR{i})}
{
- Return \retval{element \VAR{i}} of simple \VAR{vector}. \kwd{setf}able.
+ \retval{Element \VAR{i}} of simple \VAR{vector}. \kwd{setf}able.
}
\IT{(\FU*{VECTOR-PUSH} \VAR{foo} \DES{\VAR{vector}})}
View
@@ -1,4 +1,4 @@
-% Copyright (C) 2008, 2010 Bert Burgemeister
+% Copyright (C) 2008, 2010, 2011 Bert Burgemeister
%
% Permission is granted to copy, distribute and/or modify this
% document under the terms of the GNU Free Documentation License,
@@ -102,13 +102,13 @@ \section{Characters}
\retval{Character} representing digit \VAR{i}.
}
- \IT{(\FU*{CHAR-NAME} \VAR{character})}
+ \IT{(\FU*{CHAR-NAME} \VAR{char})}
{
- \VAR{character}'s \retval{name} if any, or
+ \VAR{char}'s \retval{name} if any, or
\retval{\NIL}.
}
- \IT{(\FU*{NAME-CHAR} \VAR{foo})}
+ \IT{(\FU*{NAME-CHAR} \VAR{foo})\qquad\qquad}
{
\retval{Character} named \VAR{foo} if any, or
\retval{\NIL}.
@@ -120,7 +120,7 @@ \section{Characters}
\retval{Code} of \VAR{character}.
}
- \IT{(\FU*{CODE-CHAR} \VAR{code})}
+ \IT{(\FU*{CODE-CHAR} \VAR{code})\qquad\qquad}
{
\retval{Character} with \VAR{code}.
}
View
@@ -17,7 +17,7 @@ \subsection{Classes}
\begin{LIST}{1cm}
- \IT{(\FU*{SLOT-EXISTS-P} \VAR{foo} \VAR{bar})}
+ \IT{(\FU*{SLOT-EXISTS-P} \VAR{foo} \VAR{bar})\qquad\qquad}
{
\retval{\T} if \VAR{foo} has a slot \VAR{bar}.
}
View
@@ -28,7 +28,7 @@ \subsection{Predicates}
Return \retval{\T} if \VAR{list}/\VAR{foo} is \NIL.
}
- \IT{(\FU*{ATOM} \VAR{foo})\qquad\qquad}
+ \IT{(\FU*{ATOM} \VAR{foo})\qquad}
{Return \retval{\T} if \VAR{foo} is not a
\kwd{cons}.
}
@@ -82,7 +82,7 @@ \subsection{Lists}
Return new cons \retval{(\VAR{foo} \kwd {.} \VAR{bar})}.
}
- \IT{(\FU*{LIST} \OPn{\VAR{foo}})}
+ \IT{(\FU*{LIST} \OPn{\VAR{foo}})\qquad\qquad}
{Return \retval{list of \VAR{foo}s}.
}
@@ -48,12 +48,12 @@ \subsection{Predicates}
\kwd{:test} function, and \FU{equalp} elements.
}
- \IT{(\FU*{NOT} \VAR{foo})}
+ \IT{(\FU*{NOT} \VAR{foo})\qquad\qquad\qquad}
{
\retval{\T} if \VAR{foo} is \NIL; \retval{\NIL} otherwise.
}
- \IT{(\FU*{BOUNDP} \VAR{symbol})}
+ \IT{(\FU*{BOUNDP} \VAR{symbol})\qquad\qquad}
{
\retval{\T} if \VAR{symbol} is a special variable.
}
@@ -63,7 +63,7 @@ \subsection{Predicates}
\retval{\T} if \VAR{foo} is a constant form.
}
- \IT{(\FU*{FUNCTIONP} \VAR{foo})}
+ \IT{(\FU*{FUNCTIONP} \VAR{foo})\qquad\qquad}
{
\retval{\T} if \VAR{foo} is of type \kwd{function}.
}
@@ -1,4 +1,4 @@
-% Copyright (C) 2008, 2010 Bert Burgemeister
+% Copyright (C) 2008, 2010, 2011 Bert Burgemeister
%
% Permission is granted to copy, distribute and/or modify this
% document under the terms of the GNU Free Documentation License,
@@ -18,14 +18,17 @@ \section{External Environment}
\retval{Current time}, or \retval{computing time},
respectively, in clock ticks.
}
-
+
\IT{\CNS*{INTERNAL-TIME-UNITS-PER-SECOND}}
{
Number of clock ticks per second.
}
-
- \IT{\arrGOO{(\FU*{ENCODE-UNIVERSAL-TIME} \VAR{ sec} \VAR{ min}
- \VAR{ hour} \VAR{ date} \VAR{ month} \VAR{ year }
+
+ \IT{\arrGOO{%
+ (\FU*{ENCODE-UNIVERSAL-TIME}
+ \VAR{\hspace{.7ex}sec} \VAR{\hspace{.7ex}min}
+ \VAR{\hspace{.7ex}hour} \VAR{\hspace{.7ex}date}
+ \VAR{\hspace{.7ex}month} \VAR{\hspace{.7ex}year\hspace{1ex}}
\Op{\VAR{zone}\DF{curr}})\\
(\FU*{GET-UNIVERSAL-TIME})}{.}}
{
View
@@ -651,7 +651,7 @@ \subsection{Printer}
\IT{\V{\A print-pretty\A}}
{\index{*PRINT-PRETTY*@\A PRINT-PRETTY\A}
- If \T, print pretty.
+ If \T, print prettily.
}
\IT{\V{\A print-radix\A}\DF{\NIL}}
View
@@ -42,15 +42,15 @@ \subsection{Predicates}
\IT{\arrGOO{(\FU*{MINUSP} \VAR{ a})\\
(\FU*{ZEROP} \VAR{ a})\\
(\FU*{PLUSP}
- \VAR{ a})}{.}\qquad\qquad}
+ \VAR{ a})}{.}}
{
\retval{\T} if $a < 0$, $a = 0$, or $a > 0$, respectively.
}
- \IT{\arrGOO{(\FU*{EVENP } \VAR{integer})\\
- (\FU*{ODDP } \VAR{integer})}{.}}
+ \IT{\arrGOO{(\FU*{EVENP } \VAR{int})\\
+ (\FU*{ODDP } \VAR{int})}{.}}
{
- \retval{\T} if \VAR{integer} is even or odd, respectively.
+ \retval{\T} if \VAR{int} is even or odd, respectively.
}
\IT{\arrGOO{(\FU*{NUMBERP} \VAR{ foo})\\
@@ -114,9 +114,9 @@ \subsection{Predicates}
}
\IT{\arrGOO{(\FU*{SQRT} \VAR{ n})\\
- (\FU*{ISQRT} \VAR{ n})}{.}}
+ (\FU*{ISQRT} \VAR{ n})}{.}\qquad\qquad}
{
- \retval{$\sqrt{n}$} in complex or natural numbers, respectively.
+ \retval{$\sqrt{n}$} in complex numbers/natural numbers.
}
\IT{\arrGOO{(\FU*{LCM} \OPn{\VAR{ integer}}\DF{\LIT{1}})\\
@@ -127,7 +127,7 @@ \subsection{Predicates}
returns \retval{0}.
}
- \IT{\CNS*{PI}}
+ \IT{\CNS*{PI}\qquad\qquad}
{
\kwd{long-float} approximation of $\pi$, Ludolph's number.
}
@@ -245,14 +245,16 @@ \subsection{Predicates}
}
\IT{(\FU*{COMPLEX} \VAR{real} \Op{\VAR{imag}\DF{\LIT{0}}})}
- {Make a \retval{complex number}.
- }
+ {
+ Make a \retval{complex number}.
+ }
- \IT{(\FU*{PHASE} \VAR{number})}
- {\retval{Angle} of \VAR{number}'s polar representation.
- }
+ \IT{(\FU*{PHASE} \VAR{num})}
+ {
+ \retval{Angle} of \VAR{num}'s polar representation.
+ }
- \IT{(\FU*{ABS} \VAR{n})}
+ \IT{(\FU*{ABS} \VAR{n})\qquad\qquad}
{
Return \retval{$|n|$}.
}
@@ -301,13 +303,13 @@ \subsection{Logic Functions}
\IT{\CNS*{BOOLE-ANDC2}} {\retval{$\text{\VAR{int-a}} \land \lnot\text{\VAR{int-b}}$}.}
\IT{\CNS*{BOOLE-NAND}} {\retval{$\lnot(\text{\VAR{int-a}} \land \text{\VAR{int-b}})$}.}
\IT{\CNS*{BOOLE-IOR}\qquad\qquad} {\retval{$\text{\VAR{int-a}} \lor \text{\VAR{int-b}}$}.}
- \IT{\CNS*{BOOLE-ORC1}\qquad\qquad} {\retval{$\lnot \text{\VAR{int-a}} \lor \text{\VAR{int-b}}$}.}
- \IT{\CNS*{BOOLE-ORC2}\qquad\qquad} {\retval{$\text{\VAR{int-a}} \lor \lnot\text{\VAR{int-b}}$}.}
+ \IT{\CNS*{BOOLE-ORC1}\qquad} {\retval{$\lnot \text{\VAR{int-a}} \lor \text{\VAR{int-b}}$}.}
+ \IT{\CNS*{BOOLE-ORC2}\qquad} {\retval{$\text{\VAR{int-a}} \lor \lnot\text{\VAR{int-b}}$}.}
\IT{\CNS*{BOOLE-XOR}\qquad\qquad} {\retval{$\lnot(\text{\VAR{int-a}} \equiv \text{\VAR{int-b}})$}.}
\IT{\CNS*{BOOLE-NOR}\qquad\qquad} {\retval{$\lnot(\text{\VAR{int-a}} \lor \text{\VAR{int-b}})$}.}
\end{LIST}
- \IT{(\FU*{LOGNOT}\VAR{ integer})}
+ \IT{(\FU*{LOGNOT}\VAR{ integer})\qquad\qquad}
{
\retval{$\lnot\text{\VAR{integer}}$}.
}
@@ -353,12 +355,12 @@ \subsection{Logic Functions}
\IT{(\FU*{LOGNOR} \VAR{int-a} \VAR{int-b})}
{
- \retval{$\lnot(\text{\VAR{int-a}} \lor \text{\VAR{int-b}})$}.
+ \retval{$\lnot(\text{\VAR{int-a}} \lor \text{\VAR{int-b}})$}.
}
- \IT{(\FU*{LOGBITP} \VAR{i} \VAR{integer})}
+ \IT{(\FU*{LOGBITP} \VAR{i} \VAR{int})}
{
- \retval{\T} if zero-indexed \VAR{i}th bit of \VAR{integer} is set.
+ \retval{\T} if zero-indexed \VAR{i}th bit of \VAR{int} is set.
}
\IT{(\FU*{LOGTEST} \VAR{int-a} \VAR{int-b})}
@@ -1,4 +1,4 @@
-% Copyright (C) 2008, 2009, 2010 Bert Burgemeister
+% Copyright (C) 2008, 2009, 2010, 2011 Bert Burgemeister
%
% Permission is granted to copy, distribute and/or modify this
% document under the terms of the GNU Free Documentation License,
@@ -105,7 +105,7 @@ \subsection{Packages}
Delete \VAR{package}. Return \retval{\T} if successful.
}
- \IT{\V{\A package\A}\DF{\kwd{common-lisp-user}}\qquad\quad}
+ \IT{\V{\A package\A}\DF{\kwd{common-lisp-user}}\qquad\qquad}
{\index{*PACKAGE*@\A PACKAGE\A}
The current package.
}
@@ -115,14 +115,14 @@ \subsection{Packages}
\retval{List of registered packages}.
}
- \IT{(\FU*{PACKAGE-NAME} \VAR{package})\qquad\quad}
+ \IT{(\FU*{PACKAGE-NAME} \VAR{package})}
{
\retval{Name of \VAR{package}}.
}
\IT{(\FU*{PACKAGE-NICKNAMES} \VAR{package})}
{
- \retval{List of nicknames} of \VAR{package}.
+ \retval{Nicknames} of \VAR{package}.
}
\IT{(\FU*{FIND-PACKAGE} \VAR{name})}
@@ -1,4 +1,4 @@
-% Copyright (C) 2008, 2009, 2010 Bert Burgemeister
+% Copyright (C) 2008, 2009, 2010, 2011 Bert Burgemeister
%
% Permission is granted to copy, distribute and/or modify this
% document under the terms of the GNU Free Documentation License,
@@ -186,7 +186,7 @@ \section{Types and Classes}
\IT{(\FU*{STREAM-ELEMENT-TYPE} \VAR{stream})}
{
- Return \retval{type} of \VAR{stream} objects.
+ \retval{Type} of \VAR{stream} objects.
}
\IT{(\FU*{ARRAY-ELEMENT-TYPE} \VAR{array})}
Oops, something went wrong.

0 comments on commit 5cbb6d8

Please sign in to comment.