Skip to content

Commit a4c8dc4

Browse files
committed
manual: Wrap booleans with @code
1 parent 6aabd58 commit a4c8dc4

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

docs/epkg.org

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ about the package at point in another buffer.
136136

137137
- HEADER is the string displayed in the header.
138138
- WIDTH is the width of the column.
139-
- SORT is a boolean or a function. If it is t, then the column can
140-
be sorted alphanumerically, if it is nil then it can not. If it
139+
- SORT is a boolean or a function. If it is ~t~, then the column can
140+
be sorted alphanumerically, if it is ~nil~ then it can not. If it
141141
is a function then that is used as ~sort~'s PREDICATE.
142142

143143
- PROPS is an alist, supported keys are ~:right-align~ and ~:pad-right~.
@@ -246,7 +246,7 @@ libraries are required.
246246
Each element of the list can be a function, a slot symbol, or ~nil~.
247247
Functions are called with one argument, the Epkg object, and should
248248
insert a representation of the value at point. Raw slot symbols
249-
cause its non-nil value to be inserted as-is. If a slot's value is
249+
cause its non-~nil~ value to be inserted as-is. If a slot's value is
250250
~nil~, then nothing is inserted. Elements that are ~nil~ stand for
251251
empty lines.
252252

@@ -391,13 +391,13 @@ e.g., ~(oref (epkg "magit") url)~.
391391
values or database rows. The list is ordered by the package
392392
names in ascending order.
393393

394-
If optional SELECT is non-nil, then it has to be symbol naming
394+
If optional SELECT is non-~nil~, then it has to be symbol naming
395395
a column in the ~packages~ table or a vector of such columns.
396396
In those cases the returned value is a list of column values
397-
or a list of database rows. If SELECT is nil, return a list
397+
or a list of database rows. If SELECT is ~nil~, return a list
398398
of objects.
399399

400-
If optional TYPES is non-nil, then it has to be a vector of
400+
If optional TYPES is non-~nil~, then it has to be a vector of
401401
package types, such as ~github~. To include subtypes, add an
402402
asterisk to the symbol name, e.g., ~mirrored*~. For backward
403403
compatibility, TYPES can also be a list of predicate functions
@@ -431,7 +431,7 @@ functions return these values in a form that is generally more useful.
431431
string.
432432

433433
Bundled features are excluded from the returned list unless
434-
optional INCLUDE-BUNDLED is non-nil.
434+
optional INCLUDE-BUNDLED is non-~nil~.
435435

436436
- Function: epkg-required package ::
437437

@@ -484,16 +484,16 @@ functions return these values in a form that is generally more useful.
484484

485485
This function returns a list of all package types.
486486

487-
If optional SUBTYPES is non-nil, then it also returns symbols of the
487+
If optional SUBTYPES is non-~nil~, then it also returns symbols of the
488488
form ~TYPE*~, which stands for "~TYPE~ and its subtypes".
489489

490490
- Function: epkg-read-type prompt &optional default subtypes ::
491491

492492
This function reads an Epkg type in the minibuffer and returns it as
493493
a symbol.
494494

495-
If optional DEFAULT is non-nil, then that is offered as default
496-
choice. If optional CHILDP is non-nil, then entries of the form
495+
If optional DEFAULT is non-~nil~, then that is offered as default
496+
choice. If optional CHILDP is non-~nil~, then entries of the form
497497
~TYPE*~, which stands for "~TYPE~ and its subtypes", are also offered
498498
as completion candidates.
499499

@@ -502,7 +502,7 @@ functions return these values in a form that is generally more useful.
502502
This function reads the name of an Epkg package in the minibuffer
503503
and returns it as a string.
504504

505-
Optional DEFAULT, if non-nil, is offered as default choice.
505+
Optional DEFAULT, if non-~nil~, is offered as default choice.
506506

507507
* Querying the Database
508508

docs/epkg.texi

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ HEADER is the string displayed in the header.
185185
@item
186186
WIDTH is the width of the column.
187187
@item
188-
SORT is a boolean or a function. If it is t, then the column can
189-
be sorted alphanumerically, if it is nil then it can not. If it
188+
SORT is a boolean or a function. If it is @code{t}, then the column can
189+
be sorted alphanumerically, if it is @code{nil} then it can not. If it
190190
is a function then that is used as @code{sort}'s PREDICATE@.
191191

192192
@item
@@ -300,7 +300,7 @@ displaying information about an Epkg package in a help buffer.
300300
Each element of the list can be a function, a slot symbol, or @code{nil}.
301301
Functions are called with one argument, the Epkg object, and should
302302
insert a representation of the value at point. Raw slot symbols
303-
cause its non-nil value to be inserted as-is. If a slot's value is
303+
cause its non-@code{nil} value to be inserted as-is. If a slot's value is
304304
@code{nil}, then nothing is inserted. Elements that are @code{nil} stand for
305305
empty lines.
306306
@end defopt
@@ -480,13 +480,13 @@ This function returns a list of @code{epkg-package} objects, column
480480
values or database rows. The list is ordered by the package
481481
names in ascending order.
482482

483-
If optional SELECT is non-nil, then it has to be symbol naming
483+
If optional SELECT is non-@code{nil}, then it has to be symbol naming
484484
a column in the @code{packages} table or a vector of such columns.
485485
In those cases the returned value is a list of column values
486-
or a list of database rows. If SELECT is nil, return a list
486+
or a list of database rows. If SELECT is @code{nil}, return a list
487487
of objects.
488488

489-
If optional TYPES is non-nil, then it has to be a vector of
489+
If optional TYPES is non-@code{nil}, then it has to be a vector of
490490
package types, such as @code{github}. To include subtypes, add an
491491
asterisk to the symbol name, e.g., @code{mirrored*}. For backward
492492
compatibility, TYPES can also be a list of predicate functions
@@ -520,7 +520,7 @@ PACKAGE@. PACKAGE is an @code{epkg-package} object or a package name, a
520520
string.
521521

522522
Bundled features are excluded from the returned list unless
523-
optional INCLUDE-BUNDLED is non-nil.
523+
optional INCLUDE-BUNDLED is non-@code{nil}.
524524
@end defun
525525

526526
@defun epkg-required package
@@ -573,16 +573,16 @@ because the latter is longer and an implementation detail.
573573
@defun epkg-package-types subtypes
574574
This function returns a list of all package types.
575575

576-
If optional SUBTYPES is non-nil, then it also returns symbols of the
576+
If optional SUBTYPES is non-@code{nil}, then it also returns symbols of the
577577
form @code{TYPE*}, which stands for "@code{TYPE} and its subtypes".
578578
@end defun
579579

580580
@defun epkg-read-type prompt &optional default subtypes
581581
This function reads an Epkg type in the minibuffer and returns it as
582582
a symbol.
583583

584-
If optional DEFAULT is non-nil, then that is offered as default
585-
choice. If optional CHILDP is non-nil, then entries of the form
584+
If optional DEFAULT is non-@code{nil}, then that is offered as default
585+
choice. If optional CHILDP is non-@code{nil}, then entries of the form
586586
@code{TYPE*}, which stands for "@code{TYPE} and its subtypes", are also offered
587587
as completion candidates.
588588
@end defun
@@ -591,7 +591,7 @@ as completion candidates.
591591
This function reads the name of an Epkg package in the minibuffer
592592
and returns it as a string.
593593

594-
Optional DEFAULT, if non-nil, is offered as default choice.
594+
Optional DEFAULT, if non-@code{nil}, is offered as default choice.
595595
@end defun
596596

597597
@node Querying the Database

0 commit comments

Comments
 (0)