aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2022-04-08 20:15:28 +0200
committerPhilip Kaludercic <philipk@posteo.net>2022-04-08 22:04:21 +0200
commit015fbedf4be46f4a7cb42115ddb96c40d5f1616b (patch)
treee73489d93286af49b550cfb45896846bb55b6616
parentf6f4c386a6fb4c8b2e81488962c44c22cf2546c5 (diff)
Do not omit the prefix when documenting a prefixed symbol
Implemented functions and variables appear in the respective indices exactly as written. If we do not prefix these symbols then the risk is very high that someone will look at the index and see that some function is defined in this package and start to use it, when in actuality it is only the prefixed symbol that is defined here.
-rw-r--r--MANUAL46
-rw-r--r--compat.texi46
2 files changed, 46 insertions, 46 deletions
diff --git a/MANUAL b/MANUAL
index 77f1245..10405e7 100644
--- a/MANUAL
+++ b/MANUAL
@@ -132,15 +132,15 @@ provided by Compat by default:
These functions are prefixed with ~compat~ prefix, and are only loaded
when ~compat-24~ is required:
-- Function: = ::
-- Function: < ::
-- Function: > ::
-- Function: <= ::
-- Function: >= ::
+- Function: compat-= ::
+- Function: compat-< ::
+- Function: compat-> ::
+- Function: compat-<= ::
+- Function: compat->= ::
See [[info:elisp#Comparison of Numbers][(elisp) Comparison of Numbers]].
Allows for more than two arguments to be compared.
-- Function: split-string :: See [[info:elisp#Creating Strings][(elisp) Creating Strings]].
+- Function: compat-split-string :: See [[info:elisp#Creating Strings][(elisp) Creating Strings]].
Takes optional argument TRIM.
@@ -186,7 +186,7 @@ provided by Compat by default:
These functions are prefixed with ~compat~ prefix, and are only loaded
when ~compat-25~ is required:
-- Function: sort :: See [[info:elisp#Sequence Functions][(elisp) Sequence Functions]].
+- Function: compat-sort :: See [[info:elisp#Sequence Functions][(elisp) Sequence Functions]].
Adds support for vectors to be sorted, next to just lists.
@@ -232,13 +232,13 @@ provided by Compat by default:
These functions are prefixed with ~compat~ prefix, and are only loaded
when ~compat-26~ is required:
-- Function: assoc :: See [[info:elisp#Association Lists][(elisp) Association Lists]].
+- Function: compat-assoc :: See [[info:elisp#Association Lists][(elisp) Association Lists]].
Handle the optional argument TESTFN.
-- Function: line-number-at-pos :: See [[info:elisp#Text Lines][(elisp) Text Lines]].
+- Function: compat-line-number-at-pos :: See [[info:elisp#Text Lines][(elisp) Text Lines]].
Handle the optional argument ABSOLUTE.
-- Function: alist-get :: See [[info:elisp#Association Lists][(elisp) Association Lists]].
+- Function: compat-alist-get :: See [[info:elisp#Association Lists][(elisp) Association Lists]].
Handle the optional argument TESTFN.
@@ -292,22 +292,22 @@ provided by Compat by default:
These functions are prefixed with ~compat~ prefix, and are only loaded
when ~compat-27~ is required:
-- Function: recenter :: See [[info:elisp#Textual Scrolling][(elisp) Textual Scrolling]].
+- Function: compat-recenter :: See [[info:elisp#Textual Scrolling][(elisp) Textual Scrolling]].
Adds the optional argument REDISPLAY.
-- Function: lookup-key :: See [[info:elisp#Low-Level Key Binding][(elisp) Low-Level Key Binding]].
+- Function: compat-lookup-key :: See [[info:elisp#Low-Level Key Binding][(elisp) Low-Level Key Binding]].
Allows KEYMAP to be a list of keymaps.
-- Macro: setq-local :: See [[info:elisp#Creating Buffer-Local][(elisp) Creating Buffer-Local]].
+- Macro: compat-setq-local :: See [[info:elisp#Creating Buffer-Local][(elisp) Creating Buffer-Local]].
Allow for more than one variable to be set.
-- Function: regexp-opt :: See [[info:elisp#Regexp Functions][(elisp) Regexp Functions]].
+- Function: compat-regexp-opt :: See [[info:elisp#Regexp Functions][(elisp) Regexp Functions]].
Handle an empty list of strings.
-- Function: file-size-human-readable :: Defined in ~files.el~.
+- Function: compat-file-size-human-readable :: Defined in ~files.el~.
Handle the optional third (SPACE) and forth (UNIT) arguments.
-- Function: assoc-delete-all :: See [[info:elisp#Association Lists][(elisp) Association Lists]].
+- Function: compat-assoc-delete-all :: See [[info:elisp#Association Lists][(elisp) Association Lists]].
Handle the optional third (TESTFN) argument.
@@ -377,27 +377,27 @@ provided by Compat by default:
These functions are prefixed with ~compat~ prefix, and are only loaded
when ~compat-28~ is required:
-- Function: unlock-buffer :: See [[info:elisp#File Locks][(elisp) File Locks]].
+- Function: compat-unlock-buffer :: See [[info:elisp#File Locks][(elisp) File Locks]].
Handle ~file-error~ conditions.
-- Function: string-width :: See [[info:elisp#Size of Displayed Text][(elisp) Size of Displayed Text]].
+- Function: compat-string-width :: See [[info:elisp#Size of Displayed Text][(elisp) Size of Displayed Text]].
Handle optional arguments FROM and TO.
-- Function: json-serialize :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
+- Function: compat-json-serialize :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
Handle primitive, top-level JSON values.
-- Function: json-insert :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
+- Function: compat-json-insert :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
Handle primitive, top-level JSON values.
-- Function: json-parse-string :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
+- Function: compat-json-parse-string :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
Handle primitive, top-level JSON values.
-- Function: json-parse-buffer :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
+- Function: compat-json-parse-buffer :: See [[info:elisp#Parsing JSON][(elisp) Parsing JSON]].
Handle primitive, top-level JSON values.
-- Function: count-windows :: Defined in ~window.el~.
+- Function: compat-count-windows :: Defined in ~window.el~.
Handle optional argument ALL-FRAMES.
diff --git a/compat.texi b/compat.texi
index 40b8692..6db3add 100644
--- a/compat.texi
+++ b/compat.texi
@@ -297,21 +297,21 @@ See @ref{Defining Faces,(elisp) Defining Faces,,elisp,}.
These functions are prefixed with @code{compat} prefix, and are only loaded
when @code{compat-24} is required:
-@defun =
+@defun compat-=
@end defun
-@defun <
+@defun compat-<
@end defun
-@defun >
+@defun compat->
@end defun
-@defun <=
+@defun compat-<=
@end defun
-@defun >=
+@defun compat->=
See @ref{Comparison of Numbers,(elisp) Comparison of Numbers,,elisp,}.
Allows for more than two arguments to be compared.
@end defun
-@defun split-string
+@defun compat-split-string
See @ref{Creating Strings,(elisp) Creating Strings,,elisp,}.
Takes optional argument TRIM@.
@@ -419,7 +419,7 @@ See @ref{Bool-Vectors,(elisp) Bool-Vectors,,elisp,}.
These functions are prefixed with @code{compat} prefix, and are only loaded
when @code{compat-25} is required:
-@defun sort
+@defun compat-sort
See @ref{Sequence Functions,(elisp) Sequence Functions,,elisp,}.
Adds support for vectors to be sorted, next to just lists.
@@ -519,19 +519,19 @@ See @ref{Unique File Names,(elisp) Unique File Names,,elisp,}.
These functions are prefixed with @code{compat} prefix, and are only loaded
when @code{compat-26} is required:
-@defun assoc
+@defun compat-assoc
See @ref{Association Lists,(elisp) Association Lists,,elisp,}.
Handle the optional argument TESTFN@.
@end defun
-@defun line-number-at-pos
+@defun compat-line-number-at-pos
See @ref{Text Lines,(elisp) Text Lines,,elisp,}.
Handle the optional argument ABSOLUTE@.
@end defun
-@defun alist-get
+@defun compat-alist-get
See @ref{Association Lists,(elisp) Association Lists,,elisp,}.
Handle the optional argument TESTFN@.
@@ -670,37 +670,37 @@ Defined in @code{package.el}.
These functions are prefixed with @code{compat} prefix, and are only loaded
when @code{compat-27} is required:
-@defun recenter
+@defun compat-recenter
See @ref{Textual Scrolling,(elisp) Textual Scrolling,,elisp,}.
Adds the optional argument REDISPLAY@.
@end defun
-@defun lookup-key
+@defun compat-lookup-key
See @ref{Low-Level Key Binding,(elisp) Low-Level Key Binding,,elisp,}.
Allows KEYMAP to be a list of keymaps.
@end defun
-@defmac setq-local
+@defmac compat-setq-local
See @ref{Creating Buffer-Local,(elisp) Creating Buffer-Local,,elisp,}.
Allow for more than one variable to be set.
@end defmac
-@defun regexp-opt
+@defun compat-regexp-opt
See @ref{Regexp Functions,(elisp) Regexp Functions,,elisp,}.
Handle an empty list of strings.
@end defun
-@defun file-size-human-readable
+@defun compat-file-size-human-readable
Defined in @code{files.el}.
Handle the optional third (SPACE) and forth (UNIT) arguments.
@end defun
-@defun assoc-delete-all
+@defun compat-assoc-delete-all
See @ref{Association Lists,(elisp) Association Lists,,elisp,}.
Handle the optional third (TESTFN) argument.
@@ -889,43 +889,43 @@ See @ref{Backup Names,(elisp) Backup Names,,elisp,}.
These functions are prefixed with @code{compat} prefix, and are only loaded
when @code{compat-28} is required:
-@defun unlock-buffer
+@defun compat-unlock-buffer
See @ref{File Locks,(elisp) File Locks,,elisp,}.
Handle @code{file-error} conditions.
@end defun
-@defun string-width
+@defun compat-string-width
See @ref{Size of Displayed Text,(elisp) Size of Displayed Text,,elisp,}.
Handle optional arguments FROM and TO@.
@end defun
-@defun json-serialize
+@defun compat-json-serialize
See @ref{Parsing JSON,(elisp) Parsing JSON,,elisp,}.
Handle primitive, top-level JSON values.
@end defun
-@defun json-insert
+@defun compat-json-insert
See @ref{Parsing JSON,(elisp) Parsing JSON,,elisp,}.
Handle primitive, top-level JSON values.
@end defun
-@defun json-parse-string
+@defun compat-json-parse-string
See @ref{Parsing JSON,(elisp) Parsing JSON,,elisp,}.
Handle primitive, top-level JSON values.
@end defun
-@defun json-parse-buffer
+@defun compat-json-parse-buffer
See @ref{Parsing JSON,(elisp) Parsing JSON,,elisp,}.
Handle primitive, top-level JSON values.
@end defun
-@defun count-windows
+@defun compat-count-windows
Defined in @code{window.el}.
Handle optional argument ALL-FRAMES@.