From: Juanma Barranquero Date: Thu, 19 Sep 2019 02:32:25 +0000 (+0200) Subject: lisp/*.el, src/*.c: Fix typos in docstrings X-Git-Tag: emacs-27.0.90~1550 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=79a01866a01754b9f566af76ef96e80cd90d094b;p=emacs.git lisp/*.el, src/*.c: Fix typos in docstrings * lisp/apropos.el (apropos-do-all): * lisp/auth-source-pass.el (auth-source-pass--select-from-entries): * lisp/auth-source.el (auth-source-user-or-password): * lisp/calc/calc-forms.el (math-tzone-names): * lisp/calendar/diary-lib.el (diary-face-attrs) (diary-mark-entries-1): * lisp/cedet/cedet-files.el (cedet-files-list-recursively): * lisp/cedet/ede.el (ede-constructing, ede-deep-rescan): * lisp/cedet/ede/cpp-root.el (ede-cpp-root-header-file-p): * lisp/cedet/ede/proj.el (ede-proj-target-makefile): * lisp/cedet/inversion.el (inversion-check-version) (inversion-test): * lisp/cedet/mode-local.el (mode-local-map-file-buffers): * lisp/cedet/semantic/complete.el (semantic-displayer-ghost): * lisp/cedet/semantic/db-find.el (semanticdb-find-translate-path-default): * lisp/cedet/semantic/db.el (semanticdb-table) (semanticdb-search-system-databases): * lisp/cedet/semantic/imenu.el (semantic-imenu-index-directory): * lisp/cedet/semantic/java.el (semantic-java-doc-keywords-map): * lisp/cedet/semantic/lex-spp.el (semantic-lex-spp-use-headers-flag): * lisp/cedet/semantic/lex.el (semantic-lex-make-keyword-table) (semantic-lex-make-type-table, semantic-lex-debug-analyzers): * lisp/cedet/semantic/tag-ls.el (semantic-tag-abstract-p) (semantic-tag-leaf-p, semantic-tag-static-p) (semantic-tag-prototype-p): * lisp/dnd.el (dnd-open-remote-file-function, dnd-open-local-file): * lisp/emacs-lisp/eieio-opt.el (eieio-build-class-alist) (eieio-read-class, eieio-read-subclass): * lisp/emacs-lisp/generator.el (cps--replace-variable-references) (cps--handle-loop-for): * lisp/erc/erc-dcc.el (erc-dcc-list, erc-dcc-member, erc-dcc-server) (erc-dcc-auto-mask-p, erc-dcc-get-file, erc-dcc-chat-accept): * lisp/eshell/em-pred.el (eshell-pred-file-type): * lisp/faces.el (defined-colors-with-face-attributes): * lisp/font-core.el (font-lock-mode): * lisp/frame.el (frame-restack): * lisp/net/shr.el (shr-image-animate): * lisp/org/org-agenda.el (org-agenda-change-all-lines) (org-agenda-today-p): * lisp/org/org-id.el (org-id-get): * lisp/org/org.el (org-highlight-latex-and-related) (org--valid-property-p): * lisp/org/ox-beamer.el (org-beamer--get-label): * lisp/org/ox-latex.el (org-latex--caption-above-p): * lisp/org/ox-odt.el (org-odt--copy-image-file) (org-odt--copy-formula-file): * lisp/org/ox.el (org-export-with-timestamps): * lisp/progmodes/verilog-mode.el (verilog-indent-declaration-macros): * lisp/ses.el (ses-file-format-extend-parameter-list): * lisp/term.el (ansi-term): * lisp/textmodes/bibtex.el (bibtex-no-opt-remove-re) (bibtex-beginning-of-first-entry, bibtex-autokey-get-title) (bibtex-read-key, bibtex-initialize): * lisp/textmodes/flyspell.el (flyspell-word): * lisp/view.el (view-mode-exit): * src/composite.c: * src/floatfns.c (Fisnan): Fix typos in docstrings. --- diff --git a/lisp/apropos.el b/lisp/apropos.el index 79e5a1518fe..da6cf867b4f 100644 --- a/lisp/apropos.el +++ b/lisp/apropos.el @@ -66,7 +66,7 @@ ;; I see a degradation of maybe 10-20% only. (defcustom apropos-do-all nil - "Non nil means apropos commands will search more extensively. + "Non-nil means apropos commands will search more extensively. This may be slower. This option affects the following commands: `apropos-user-option' will search all variables, not just user options. diff --git a/lisp/auth-source-pass.el b/lisp/auth-source-pass.el index f16d9108903..c45c782c27c 100644 --- a/lisp/auth-source-pass.el +++ b/lisp/auth-source-pass.el @@ -243,7 +243,7 @@ HOSTNAME should not contain any username or port number." (defun auth-source-pass--select-from-entries (entries user) "Return best matching password-store entry data from ENTRIES. -If USER is non nil, give precedence to entries containing a user field +If USER is non-nil, give precedence to entries containing a user field matching USER." (let (fallback) (catch 'auth-source-pass-break diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 74c44916992..7d8657da110 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -2259,12 +2259,12 @@ items don't have a username. This means that if you search for username \"joe\" and it matches an item but the item doesn't have a :user attribute, the username \"joe\" will be returned. -A non nil DELETE-EXISTING means deleting any matching password +A non-nil DELETE-EXISTING means deleting any matching password entry in the respective sources. This is useful only when -CREATE-MISSING is non nil as well; the intended use case is to +CREATE-MISSING is non-nil as well; the intended use case is to remove wrong password entries. -If no matching entry is found, and CREATE-MISSING is non nil, +If no matching entry is found, and CREATE-MISSING is non-nil, the password will be retrieved interactively, and it will be stored in the password database which matches best (see `auth-sources'). diff --git a/lisp/calc/calc-forms.el b/lisp/calc/calc-forms.el index 7e8a8dcc9d0..98dcfab015a 100644 --- a/lisp/calc/calc-forms.el +++ b/lisp/calc/calc-forms.el @@ -1462,7 +1462,7 @@ as measured in the integer number of days before December 31, 1 BC (Gregorian)." ( "PGT" 8 "PST" "PDT" ) ( "PST" 8 0 ) ( "PDT" 8 -1 ) ; Pacific ( "YGT" 9 "YST" "YDT" ) ( "YST" 9 0 ) ( "YDT" 9 -1 ) ; Yukon ) - "No doc yet. See calc manual for now. ") + "No doc yet. See calc manual for now.") (defvar var-TimeZone nil) diff --git a/lisp/calendar/diary-lib.el b/lisp/calendar/diary-lib.el index 06f1161b44a..5a2374a5957 100644 --- a/lisp/calendar/diary-lib.el +++ b/lisp/calendar/diary-lib.el @@ -97,7 +97,7 @@ is pre-pended to REGEXP for file-wide specifiers. ATTRIBUTE specifies which face attribute (e.g. `:foreground') to modify, or that this is a face (`:face') to apply. TYPE is the type of attribute being applied. Available TYPES (see `diary-attrtype-convert') -are: `string', `symbol', `int', `tnil', `stringtnil.'" +are: `string', `symbol', `int', `tnil', `stringtnil'." :type '(repeat (list (string :tag "Regular expression") (integer :tag "Sub-expression") (symbol :tag "Attribute (e.g. :foreground)") @@ -1257,7 +1257,7 @@ the regexp with parentheses." MARKFUNC is a function that marks entries of the appropriate type matching a given date pattern. MONTHS is an array of month names. SYMBOL marks diary entries of the type in question. ABSFUNC is a -function that converts absolute dates to dates of the appropriate type. " +function that converts absolute dates to dates of the appropriate type." (calendar-dlet* ((dayname (diary-name-pattern calendar-day-name-array calendar-day-abbrev-array)) diff --git a/lisp/cedet/cedet-files.el b/lisp/cedet/cedet-files.el index d3becd5c845..7329eb37f7f 100644 --- a/lisp/cedet/cedet-files.el +++ b/lisp/cedet/cedet-files.el @@ -89,7 +89,7 @@ specific conversions during tests." file)) (defun cedet-files-list-recursively (dir re) - "Returns list of files in directory matching to given regex" + "Return list of files in directory matching to given regex." (when (file-accessible-directory-p dir) (let ((files (directory-files dir t)) matched) diff --git a/lisp/cedet/ede.el b/lisp/cedet/ede.el index d051510a994..1969df54cde 100644 --- a/lisp/cedet/ede.el +++ b/lisp/cedet/ede.el @@ -162,12 +162,12 @@ This object's class determines how to compile and debug from a buffer.") If `ede-object' is nil, then commands will operate on this object.") (defvar ede-constructing nil - "Non nil when constructing a project hierarchy. + "Non-nil when constructing a project hierarchy. If the project is being constructed from an autoload, then the value is the autoload object being used.") (defvar ede-deep-rescan nil - "Non nil means scan down a tree, otherwise rescans are top level only. + "Non-nil means scan down a tree, otherwise rescans are top level only. Do not set this to non-nil globally. It is used internally.") diff --git a/lisp/cedet/ede/cpp-root.el b/lisp/cedet/ede/cpp-root.el index 0a77692dd71..feff63681a8 100644 --- a/lisp/cedet/ede/cpp-root.el +++ b/lisp/cedet/ede/cpp-root.el @@ -389,7 +389,7 @@ This knows details about or source tree." ;; include lists, and Preprocessor symbol tables. (cl-defmethod ede-cpp-root-header-file-p ((proj ede-cpp-root-project) name) - "Non nil if in PROJ the filename NAME is a header." + "Non-nil if in PROJ the filename NAME is a header." (save-match-data (string-match (oref proj header-match-regexp) name))) diff --git a/lisp/cedet/ede/proj.el b/lisp/cedet/ede/proj.el index 59ba3ffcf8c..2ce65e91bde 100644 --- a/lisp/cedet/ede/proj.el +++ b/lisp/cedet/ede/proj.el @@ -165,7 +165,7 @@ These are the linkers the user can choose from when setting the :label "Part of all: target" :group make :documentation - "Non nil means the rule created is part of the all: target. + "Non-nil means the rule created is part of the all: target. Setting this to nil creates the rule to build this item, but does not include it in the all: rule.") (configuration-variables diff --git a/lisp/cedet/inversion.el b/lisp/cedet/inversion.el index 3bed9d70534..83561a0dfa7 100644 --- a/lisp/cedet/inversion.el +++ b/lisp/cedet/inversion.el @@ -226,7 +226,7 @@ not an indication of new features or bug fixes." "Check that a given version meets the minimum requirement. VERSION, INCOMPATIBLE-VERSION and MINIMUM are of similar format to return entries of `inversion-decode-version', or a classic version -string. INCOMPATIBLE-VERSION can be nil. +string. INCOMPATIBLE-VERSION can be nil. RESERVED arguments are kept for a later use. Return: - nil if everything is ok. @@ -274,7 +274,7 @@ MINIMUM is of similar format to return entries of RESERVED arguments are kept for a later user. This depends on the symbols `PACKAGE-version' and optionally `PACKAGE-incompatible-version' being defined in PACKAGE. -Return nil if everything is ok. Return an error string otherwise." +Return nil if everything is ok. Return an error string otherwise." (let ((check (inversion-check-version (inversion-package-version package) (inversion-package-incompatibility-version package) @@ -306,7 +306,7 @@ OLDVERSION is of similar format to return entries of RESERVED arguments are kept for a later user. This depends on the symbols `PACKAGE-version' and optionally `PACKAGE-incompatible-version' being defined in PACKAGE. -Return nil if everything is ok. Return an error string otherwise." +Return nil if everything is ok. Return an error string otherwise." (let ((check (inversion-check-version (inversion-package-version package) (inversion-package-incompatibility-version package) diff --git a/lisp/cedet/mode-local.el b/lisp/cedet/mode-local.el index 3d2fe45fcb1..50dc3cb7937 100644 --- a/lisp/cedet/mode-local.el +++ b/lisp/cedet/mode-local.el @@ -58,7 +58,7 @@ "Run FUNCTION on every file buffer found. FUNCTION does not have arguments; when it is entered `current-buffer' is the currently selected file buffer. -If optional argument PREDICATE is non nil, only select file buffers +If optional argument PREDICATE is non-nil, only select file buffers for which the function PREDICATE returns non-nil. If optional argument BUFFERS is non-nil, it is a list of buffers to walk through. It defaults to `buffer-list'." diff --git a/lisp/cedet/semantic/complete.el b/lisp/cedet/semantic/complete.el index b438a1c6e22..8f89d1a51e2 100644 --- a/lisp/cedet/semantic/complete.el +++ b/lisp/cedet/semantic/complete.el @@ -1800,7 +1800,7 @@ Return a cons cell (X . Y)" "The overlay the ghost text is displayed in.") (first-show :initform t :documentation - "Non nil if we have not seen our first show request.") + "Non-nil if we have not seen our first show request.") ) "Cycle completions inline with ghost text. Completion displayer using ghost chars after point for focus options. diff --git a/lisp/cedet/semantic/db-find.el b/lisp/cedet/semantic/db-find.el index 54935c3a7c7..18c749b098e 100644 --- a/lisp/cedet/semantic/db-find.el +++ b/lisp/cedet/semantic/db-find.el @@ -304,7 +304,7 @@ so that it can be called from the idle work handler." (defun semanticdb-find-translate-path-default (path brutish) "Translate PATH into a list of semantic tables. -If BRUTISH is non nil, return all tables associated with PATH. +If BRUTISH is non-nil, return all tables associated with PATH. Default action as described in `semanticdb-find-translate-path'." (if (semanticdb-find-results-p path) ;; nil means perform the search over these results. diff --git a/lisp/cedet/semantic/db.el b/lisp/cedet/semantic/db.el index 33ad4701769..5c7f8423839 100644 --- a/lisp/cedet/semantic/db.el +++ b/lisp/cedet/semantic/db.el @@ -238,7 +238,7 @@ If nil, the table's buffer is no in Emacs. If it has a value, then it is in Emacs.") (dirty :initform nil :documentation - "Non nil if this table needs to be `Saved'.") + "Non-nil if this table needs to be `Saved'.") (db-refs :initform nil :documentation "List of `semanticdb-table' objects referring to this one. @@ -833,7 +833,7 @@ value.") (make-variable-buffer-local 'semanticdb-project-system-databases) (defvar semanticdb-search-system-databases t - "Non nil if search routines are to include a system database.") + "Non-nil if search routines are to include a system database.") (defun semanticdb-current-database-list (&optional dir) "Return a list of databases associated with the current buffer. diff --git a/lisp/cedet/semantic/imenu.el b/lisp/cedet/semantic/imenu.el index 009d04dbd75..5119eb62f3d 100644 --- a/lisp/cedet/semantic/imenu.el +++ b/lisp/cedet/semantic/imenu.el @@ -119,7 +119,7 @@ See `semantic-bucketize' and the FILTER argument for more details on this functi (make-variable-buffer-local 'semantic-imenu-sort-bucket-function) (defcustom semantic-imenu-index-directory nil - "Non nil to index the entire directory for tags. + "Non-nil to index the entire directory for tags. Doesn't actually parse the entire directory, but displays tags for all files currently listed in the current Semantic database. This variable has no meaning if semanticdb is not active." diff --git a/lisp/cedet/semantic/java.el b/lisp/cedet/semantic/java.el index 7f9c93b906f..b103c3ce157 100644 --- a/lisp/cedet/semantic/java.el +++ b/lisp/cedet/semantic/java.el @@ -391,7 +391,7 @@ That is TAG `symbol-name' without the leading `@'." (defun semantic-java-doc-keywords-map (fun &optional property) "Run function FUN for each javadoc keyword. -Return the list of FUN results. If optional PROPERTY is non nil only +Return the list of FUN results. If optional PROPERTY is non-nil only call FUN for javadoc keywords which have a value for PROPERTY. FUN receives two arguments: the javadoc keyword and its associated 'javadoc property list. It can return any value. All nil values are diff --git a/lisp/cedet/semantic/lex-spp.el b/lisp/cedet/semantic/lex-spp.el index 6fe33f93110..d07dc806a48 100644 --- a/lisp/cedet/semantic/lex-spp.el +++ b/lisp/cedet/semantic/lex-spp.el @@ -1244,7 +1244,7 @@ For languages that use the Semantic pre-processor, this can improve the accuracy of parsed files where include files can change the state of what's parsed in the current file. -Note: Note implemented yet" +Note: Not implemented yet." :group 'semantic :type 'boolean) diff --git a/lisp/cedet/semantic/lex.el b/lisp/cedet/semantic/lex.el index a6ee869c037..50e09e2359c 100644 --- a/lisp/cedet/semantic/lex.el +++ b/lisp/cedet/semantic/lex.el @@ -256,7 +256,7 @@ SPECS must be a list of (NAME . TOKSYM) elements, where: NAME is the name of the keyword symbol to define. TOKSYM is the lexical token symbol of that keyword. -If optional argument PROPSPECS is non nil, then interpret it, and +If optional argument PROPSPECS is non-nil, then interpret it, and apply those properties. PROPSPECS must be a list of (NAME PROPERTY VALUE) elements." ;; Create the symbol hash table @@ -414,7 +414,7 @@ SPECS must be a list of (TYPE . TOKENS) elements, where: MATCHER is a string or regexp a text must match to be a such lexical token. -If optional argument PROPSPECS is non nil, then interpret it, and +If optional argument PROPSPECS is non-nil, then interpret it, and apply those properties. PROPSPECS must be a list of (TYPE PROPERTY VALUE)." ;; Create the symbol hash table @@ -1060,7 +1060,7 @@ The collapsed tokens are saved in `semantic-lex-block-streams'." ;; to create new lexical analyzers. (defcustom semantic-lex-debug-analyzers nil - "Non nil means to debug analyzers with syntax protection. + "Non-nil means to debug analyzers with syntax protection. Only in effect if `debug-on-error' is also non-nil." :group 'semantic :type 'boolean) diff --git a/lisp/cedet/semantic/tag-ls.el b/lisp/cedet/semantic/tag-ls.el index e4627d69ebd..ad072a40960 100644 --- a/lisp/cedet/semantic/tag-ls.el +++ b/lisp/cedet/semantic/tag-ls.el @@ -369,7 +369,7 @@ For these PROTECTIONs, true is returned if TAG is: )) (define-overloadable-function semantic-tag-abstract-p (tag &optional parent) - "Return non nil if TAG is abstract. + "Return non-nil if TAG is abstract. Optional PARENT is the parent tag of TAG. In UML, abstract methods and classes have special meaning and behavior in how methods are overridden. In UML, abstract methods are italicized. @@ -393,7 +393,7 @@ See `semantic-tag-abstract-p'." abs)) (define-overloadable-function semantic-tag-leaf-p (tag &optional parent) - "Return non nil if TAG is leaf. + "Return non-nil if TAG is leaf. Optional PARENT is the parent tag of TAG. In UML, leaf methods and classes have special meaning and behavior. @@ -417,7 +417,7 @@ See `semantic-tag-leaf-p'." leaf)) (define-overloadable-function semantic-tag-static-p (tag &optional parent) - "Return non nil if TAG is static. + "Return non-nil if TAG is static. Optional PARENT is the parent tag of TAG. In UML, static methods and attributes mean that they are allocated in the parent class, and are not instance specific. @@ -436,7 +436,7 @@ See `semantic-tag-static-p'." ;;;###autoload (define-overloadable-function semantic-tag-prototype-p (tag) - "Return non nil if TAG is a prototype. + "Return non-nil if TAG is a prototype. For some languages, such as C, a prototype is a declaration of something without an implementation." ) diff --git a/lisp/cedet/semantic/wisent.el b/lisp/cedet/semantic/wisent.el index 122b5d399c0..4a759531e46 100644 --- a/lisp/cedet/semantic/wisent.el +++ b/lisp/cedet/semantic/wisent.el @@ -184,7 +184,7 @@ the standard function `semantic-parse-stream'." ;; lookahead tokens and tokens in STREAM can be different the ;; lookahead token is put in the variable `wisent-lex-lookahead' ;; before calling `wisent-parse'. Wisent's lexers always pop the - ;; next lexical token from that variable when non nil, then from + ;; next lexical token from that variable when non-nil, then from ;; the lexical input stream. ;; ;; The first element of STREAM is used to keep lookahead tokens diff --git a/lisp/dnd.el b/lisp/dnd.el index 973af7e518b..1599543c3ed 100644 --- a/lisp/dnd.el +++ b/lisp/dnd.el @@ -63,12 +63,12 @@ if some action was made, or nil if the URL is ignored." 'dnd-open-local-file 'dnd-open-remote-url) "The function to call when opening a file on a remote machine. -The function will be called with two arguments; URI and ACTION. See -`dnd-open-file' for details. +The function will be called with two arguments, URI and ACTION. +See `dnd-open-file' for details. If nil, then dragging remote files into Emacs will result in an error. Predefined functions are `dnd-open-local-file' and `dnd-open-remote-url'. `dnd-open-local-file' attempts to open a remote file using its UNC name and -is the default on MS-Windows. `dnd-open-remote-url' uses `url-handler-mode' +is the default on MS-Windows. `dnd-open-remote-url' uses `url-handler-mode' and is the default except for MS-Windows." :version "22.1" :type 'function @@ -174,7 +174,7 @@ The last / in file:/// is part of the file name. If the system natively supports unc file names, then remote urls of the form file://server-name/file-name will also be handled by this function. An alternative for systems that do not support unc file names is -`dnd-open-remote-url'. ACTION is ignored." +`dnd-open-remote-url'. ACTION is ignored." (let* ((f (dnd-get-local-file-name uri t))) (if (and f (file-readable-p f)) diff --git a/lisp/emacs-lisp/eieio-opt.el b/lisp/emacs-lisp/eieio-opt.el index f08c1de936b..fdbf05b3993 100644 --- a/lisp/emacs-lisp/eieio-opt.el +++ b/lisp/emacs-lisp/eieio-opt.el @@ -86,7 +86,7 @@ Argument CH-PREFIX is another character prefix to display." (defun eieio-build-class-alist (&optional class instantiable-only buildlist) "Return an alist of all currently active classes for completion purposes. Optional argument CLASS is the class to start with. -If INSTANTIABLE-ONLY is non nil, only allow names of classes which +If INSTANTIABLE-ONLY is non-nil, only allow names of classes which are not abstract, otherwise allow all classes. Optional argument BUILDLIST is more list to attach and is used internally." (let* ((cc (or class 'eieio-default-superclass)) @@ -107,7 +107,7 @@ Optional argument BUILDLIST is more list to attach and is used internally." (defun eieio-read-class (prompt &optional histvar instantiable-only) "Return a class chosen by the user using PROMPT. Optional argument HISTVAR is a variable to use as history. -If INSTANTIABLE-ONLY is non nil, only allow names of classes which +If INSTANTIABLE-ONLY is non-nil, only allow names of classes which are not abstract." (intern (completing-read prompt (eieio-build-class-alist nil instantiable-only) nil t nil @@ -117,7 +117,7 @@ are not abstract." "Return a class chosen by the user using PROMPT. CLASS is the base class, and completion occurs across all subclasses. Optional argument HISTVAR is a variable to use as history. -If INSTANTIABLE-ONLY is non nil, only allow names of classes which +If INSTANTIABLE-ONLY is non-nil, only allow names of classes which are not abstract." (intern (completing-read prompt (eieio-build-class-alist class instantiable-only) diff --git a/lisp/emacs-lisp/generator.el b/lisp/emacs-lisp/generator.el index caf5fed154b..dd709b32b09 100644 --- a/lisp/emacs-lisp/generator.el +++ b/lisp/emacs-lisp/generator.el @@ -541,7 +541,7 @@ don't yield.") (defun cps--replace-variable-references (var new-var form) "Replace all non-shadowed references to VAR with NEW-VAR in FORM. -This routine does not modify FORM. Instead, it returns a +This routine does not modify FORM. Instead, it returns a modified copy." (macroexpand-all `(cl-symbol-macrolet ((,var ,new-var)) ,form) @@ -760,7 +760,7 @@ Return the value with which ITERATOR finished iteration." (cps--advance-for ,cs)))) (defun cps--handle-loop-for (var) - "Support `iter-by' in `loop'. " + "Support `iter-by' in `loop'." ;; N.B. While the cl-loop-for-handler is a documented interface, ;; there's no documented way for cl-loop-for-handler callbacks to do ;; anything useful! Additionally, cl-loop currently lexbinds useful diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index 526add1a61f..f3b23369981 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -88,13 +88,13 @@ All values of the list must be uppercase strings.") (:nick \"nick\" :type SEND :peer server-proc :parent parent-proc :file file :sent :confirmed )) - :nick - a user or userhost for the peer. combine with :parent to reach them + :nick - a user or userhost for the peer. Combine with :parent to reach them :type - the type of DCC connection - SEND for outgoing files, GET for - incoming, and CHAT for both directions. To tell which end started + incoming, and CHAT for both directions. To tell which end started the DCC chat, look at :peer - :peer - the other end of the DCC connection. In the case of outgoing DCCs, + :peer - the other end of the DCC connection. In the case of outgoing DCCs, this represents a server process until a connection is established :parent - the server process where the dcc connection was established. @@ -102,7 +102,7 @@ All values of the list must be uppercase strings.") connection is in general independent from a particular server connection after it was established. - :file - for outgoing sends, the full path to the file. for incoming sends, + :file - for outgoing sends, the full path to the file. For incoming sends, the suggested filename or vetted filename :size - size of the file, may be nil on incoming DCCs") @@ -163,11 +163,11 @@ All values of the list must be uppercase strings.") (defun erc-dcc-member (&rest args) "Return the first matching entry in `erc-dcc-list' which satisfies the -constraints given as a plist in ARGS. Returns nil on no match. +constraints given as a plist in ARGS. Returns nil on no match. The property :nick is treated specially, if it contains a `!' character, it is treated as a nick!user@host string, and compared with the :nick property -value of the individual elements using string-equal. Otherwise it is +value of the individual elements using string-equal. Otherwise it is compared with `erc-nick-equal-p' which is IRC case-insensitive." (let ((list erc-dcc-list) result test) @@ -338,8 +338,8 @@ string \".*!.*@.*\" to this list." :type '(repeat regexp)) (defun erc-dcc-server (name filter sentinel) - "Start listening on a port for an incoming DCC connection. Returns the newly -created subprocess, or nil." + "Start listening on a port for an incoming DCC connection. +Returns the newly created subprocess, or nil." (let ((port (or (and erc-dcc-port-range (car erc-dcc-port-range)) t)) (upper (and erc-dcc-port-range (cdr erc-dcc-port-range))) process) @@ -686,7 +686,7 @@ It extracts the information about the dcc request and adds it to (defun erc-dcc-auto-mask-p (spec) "Takes a full SPEC of a user in the form \"nick!login@host\" and -matches against all the regexp's in `erc-dcc-auto-masks'. If any +matches against all the regexp's in `erc-dcc-auto-masks'. If any match, returns that regexp and nil otherwise." (let ((lst erc-dcc-auto-masks)) (while (and lst @@ -908,7 +908,7 @@ other client." (defun erc-dcc-get-file (entry file parent-proc) "This function does the work of setting up a transfer from the remote client -to the local one over a tcp connection. This involves setting up a process +to the local one over a tcp connection. This involves setting up a process filter and a process sentinel, and making the connection." (let* ((buffer (generate-new-buffer (file-name-nondirectory file))) proc) @@ -1156,7 +1156,7 @@ other client." buffer)) (defun erc-dcc-chat-accept (entry parent-proc) - "Accept an incoming DCC connection and open a DCC window" + "Accept an incoming DCC connection and open a DCC window." (let* ((nick (erc-extract-nick (plist-get entry :nick))) buffer proc) (setq proc diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el index cfef59f962e..ca5e2fafa96 100644 --- a/lisp/eshell/em-pred.el +++ b/lisp/eshell/em-pred.el @@ -461,7 +461,7 @@ resultant list of strings." (defun eshell-pred-file-type (type) "Return a test which tests that the file is of a certain TYPE. TYPE must be a character, and should be one of the possible options -that `ls -l' will show in the first column of its display. " +that `ls -l' will show in the first column of its display." (when (eq type ?%) (setq type (char-after)) (if (memq type '(?b ?c)) diff --git a/lisp/faces.el b/lisp/faces.el index 5193c216d0a..efae101cd88 100644 --- a/lisp/faces.el +++ b/lisp/faces.el @@ -1850,7 +1850,7 @@ If FRAME is nil, that stands for the selected frame." (defun defined-colors-with-face-attributes (&optional frame) "Return a list of colors supported for a particular frame. See `defined-colors' for arguments and return value. In contrast -to `define-colors' the elements of the returned list are color +to `define-colorss' the elements of the returned list are color strings with text properties, that make the color names render with the color they represent as background color." (mapcar diff --git a/lisp/font-core.el b/lisp/font-core.el index 6b26f0cb92e..e424506795d 100644 --- a/lisp/font-core.el +++ b/lisp/font-core.el @@ -126,7 +126,7 @@ buffer local value for `font-lock-defaults', via its mode hook. The above is the default behavior of `font-lock-mode'; you may specify your own function which is called when `font-lock-mode' -is toggled via `font-lock-function'. " +is toggled via `font-lock-function'." nil nil nil :after-hook (font-lock-initial-fontify) ;; Don't turn on Font Lock mode if we don't have a display (we're running a diff --git a/lisp/frame.el b/lisp/frame.el index fd7e872fb6d..e9d4b2ebe4c 100644 --- a/lisp/frame.el +++ b/lisp/frame.el @@ -1817,7 +1817,7 @@ below (above if ABOVE is true) that of FRAME2. Hence the position of FRAME2 in its display's Z (stacking) order relative to all other frames excluding FRAME1 remains unaltered. -Some window managers may refuse to restack windows. " +Some window managers may refuse to restack windows." (if (and (frame-live-p frame1) (frame-live-p frame2) (equal (frame-parameter frame1 'display) diff --git a/lisp/international/kkc.el b/lisp/international/kkc.el index 6691ee9eb9b..437971742dc 100644 --- a/lisp/international/kkc.el +++ b/lisp/international/kkc.el @@ -613,7 +613,7 @@ and change the current conversion to the last one in the group." (message "%s" msg)))) ;; Update the conversion area with the latest conversion selected. -;; ALL if non nil means to update the whole area, else update only +;; ALL if non-nil means to update the whole area, else update only ;; inside quail-overlay-head. (defun kkc-update-conversion (&optional all) diff --git a/lisp/net/shr.el b/lisp/net/shr.el index 1dff129b9dc..e73c7cdee1b 100644 --- a/lisp/net/shr.el +++ b/lisp/net/shr.el @@ -115,7 +115,7 @@ Alternative suggestions are: 'browse-url-secondary-browser-function "27.1") (defcustom shr-image-animate t - "Non nil means that images that can be animated will be." + "Non-nil means that images that can be animated will be." :version "24.4" :type 'boolean) diff --git a/lisp/org/org-agenda.el b/lisp/org/org-agenda.el index a6195cfb2a5..e50ec3cf08f 100644 --- a/lisp/org/org-agenda.el +++ b/lisp/org/org-agenda.el @@ -8908,7 +8908,7 @@ The new content of the line will be NEWHEAD (as modified by If FIXFACE is non-nil, the face of each item is modified according to the new TODO state. If JUST-THIS is non-nil, change just the current line, not all. -If FORCE-TAGS is non nil, the car of it returns the new tags." +If FORCE-TAGS is non-nil, the car of it returns the new tags." (let* ((inhibit-read-only t) (line (org-current-line)) (org-agenda-buffer (current-buffer)) @@ -10205,7 +10205,7 @@ to override `appt-message-warning-time'." (message "Added %d event%s for today" cnt (if (> cnt 1) "s" ""))))) (defun org-agenda-today-p (date) - "Non nil when DATE means today. + "Non-nil when DATE means today. DATE is either a list of the form (month day year) or a number of days as returned by `calendar-absolute-from-gregorian' or `org-today'. This function considers `org-extend-today-until' diff --git a/lisp/org/org-id.el b/lisp/org/org-id.el index 34084bfa109..7f7faaae8e8 100644 --- a/lisp/org/org-id.el +++ b/lisp/org/org-id.el @@ -241,7 +241,7 @@ Create an ID if necessary." "Get the ID property of the entry at point-or-marker POM. If POM is nil, refer to the entry at point. If the entry does not have an ID, the function returns nil. -However, when CREATE is non nil, create an ID if none is present already. +However, when CREATE is non-nil, create an ID if none is present already. PREFIX will be passed through to `org-id-new'. In any case, the ID of the entry is returned." (org-with-point-at pom diff --git a/lisp/org/org.el b/lisp/org/org.el index ab29353ae89..1bb46e49c74 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -4280,7 +4280,7 @@ org-level-* faces." (defcustom org-highlight-latex-and-related nil "Non-nil means highlight LaTeX related syntax in the buffer. -When non nil, the value should be a list containing any of the +When non-nil, the value should be a list containing any of the following symbols: `latex' Highlight LaTeX snippets and environments. `script' Highlight subscript and superscript. @@ -15434,7 +15434,7 @@ but in some other way.") Being in this list makes sure that they are offered for completion.") (defun org--valid-property-p (property) - "Non nil when string PROPERTY is a valid property name." + "Non-nil when string PROPERTY is a valid property name." (not (or (equal property "") (string-match-p "\\s-" property)))) diff --git a/lisp/org/ox-beamer.el b/lisp/org/ox-beamer.el index 11574a97162..77c1b33c5d9 100644 --- a/lisp/org/ox-beamer.el +++ b/lisp/org/ox-beamer.el @@ -326,7 +326,7 @@ INFO is a plist used as a communication channel. The value is either the label specified in \"BEAMER_opt\" property, the custom ID, if there is one and -`:latex-prefer-user-labels' property has a non nil value, or +`:latex-prefer-user-labels' property has a non-nil value, or a unique internal label. This function assumes HEADLINE will be treated as a frame." (cond diff --git a/lisp/org/ox-latex.el b/lisp/org/ox-latex.el index d711530bf71..b029f828e4f 100644 --- a/lisp/org/ox-latex.el +++ b/lisp/org/ox-latex.el @@ -1236,7 +1236,7 @@ calling `org-latex-compile'." ;;; Internal Functions (defun org-latex--caption-above-p (element info) - "Non nil when caption is expected to be located above ELEMENT. + "Non-nil when caption is expected to be located above ELEMENT. INFO is a plist holding contextual information." (let ((above (plist-get info :latex-caption-above))) (if (symbolp above) above diff --git a/lisp/org/ox-odt.el b/lisp/org/ox-odt.el index 8deb6bd51ab..999a2b7f5cf 100644 --- a/lisp/org/ox-odt.el +++ b/lisp/org/ox-odt.el @@ -2174,7 +2174,7 @@ SHORT-CAPTION are strings." ;;;; Links :: Inline Images (defun org-odt--copy-image-file (path) - "Returns the internal name of the file" + "Return the internal name of the file" (let* ((image-type (file-name-extension path)) (media-type (format "image/%s" image-type)) (target-dir "Images/") @@ -2379,7 +2379,7 @@ used as a communication channel." (concat equation "" label)))))) (defun org-odt--copy-formula-file (src-file) - "Returns the internal name of the file" + "Return the internal name of the file" (let* ((target-dir (format "Formula-%04d/" (cl-incf org-odt-embedded-formulas-count))) (target-file (concat target-dir "content.xml"))) diff --git a/lisp/org/ox.el b/lisp/org/ox.el index 58bc9b0ffb0..aa04676db8d 100644 --- a/lisp/org/ox.el +++ b/lisp/org/ox.el @@ -804,7 +804,7 @@ also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"." :safe #'booleanp) (defcustom org-export-with-timestamps t - "Non nil means allow timestamps in export. + "Non-nil means allow timestamps in export. It can be set to any of the following values: t export all timestamps. diff --git a/lisp/progmodes/cc-mode.el b/lisp/progmodes/cc-mode.el index 76f5de212f2..631787d73f1 100644 --- a/lisp/progmodes/cc-mode.el +++ b/lisp/progmodes/cc-mode.el @@ -1966,7 +1966,7 @@ Note that this is a strict tail, so won't match, e.g. \"0x....\".") ;; these caches from inside them, and we must thus be sure that this ;; has already been executed. ;; - ;; This calls the language variable c-before-font-lock-functions, if non nil. + ;; This calls the language variable c-before-font-lock-functions, if non-nil. ;; This typically sets `syntax-table' properties. ;; We can sometimes get two consecutive calls to `after-change-functions' diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index 78f27295f0c..a0351610008 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -1313,7 +1313,7 @@ buffer-local values of tags table format variables." ;; Find the end of the tag and record the whole tag text. (search-forward "\177") (setq tag-text (buffer-substring (1- (point)) (point-at-bol))) - ;; If use-explicit is non nil and explicit tag is present, use it as part of + ;; If use-explicit is non-nil and explicit tag is present, use it as part of ;; return value. Else just skip it. (setq explicit-start (point)) (when (and (search-forward "\001" (point-at-bol 2) t) diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 2939108d47b..293d0b2450b 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -626,7 +626,7 @@ If nil, indent as: input [31:0] a; input \\=`CP; output c; -If non nil, treat as: +If non-nil, treat as: input [31:0] a; input \\=`CP ; output c;" diff --git a/lisp/ses.el b/lisp/ses.el index 37d0d615033..36c966432c9 100644 --- a/lisp/ses.el +++ b/lisp/ses.el @@ -1435,7 +1435,7 @@ ses--default-printer, ses--numrows, or ses--numcols." "Extend the global parameters list when file format is updated from 2 to 3. This happens when local printer function are added to a sheet that was created with SES version 2. This is not -undoable. Return nil when there was no change, and non nil otherwise." +undoable. Return nil when there was no change, and non-nil otherwise." (save-excursion (cond ((and (= ses--file-format 2) (= 3 new-file-format)) diff --git a/lisp/term.el b/lisp/term.el index 77fbb1d0915..66ae470239a 100644 --- a/lisp/term.el +++ b/lisp/term.el @@ -4209,7 +4209,7 @@ the process. Any more args are arguments to PROGRAM." (defun ansi-term (program &optional new-buffer-name) "Start a terminal-emulator in a new buffer. This is almost the same as `term' apart from always creating a new buffer, -and `C-x' being marked as a `term-escape-char'. " +and `C-x' being marked as a `term-escape-char'." (interactive (list (read-from-minibuffer "Run program: " (or explicit-shell-file-name (getenv "ESHELL") diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el index a560c2b097f..5ae8097891a 100644 --- a/lisp/textmodes/bibtex.el +++ b/lisp/textmodes/bibtex.el @@ -862,7 +862,7 @@ To interactively change the dialect use the command `bibtex-set-dialect'." (defcustom bibtex-no-opt-remove-re "\\`option" "If a field name matches this regexp, the prefix OPT is not removed. -If nil prefix OPT is always removed" +If nil prefix OPT is always removed." :group 'bibtex :version "24.1" :type '(choice (regexp) (const nil))) @@ -2188,7 +2188,7 @@ If FLAG is nil, a message is echoed if point was incremented at least (defun bibtex-beginning-of-first-entry () "Go to beginning of line of first BibTeX entry in buffer. If `bibtex-sort-ignore-string-entries' is non-nil, @String entries -are ignored. Return point" +are ignored. Return point." (goto-char (point-min)) (bibtex-skip-to-valid-entry) (point)) @@ -2714,7 +2714,7 @@ and `bibtex-autokey-names-stretch'." (defun bibtex-autokey-get-title () "Get title field contents up to a terminator. -Return the result as a string" +Return the result as a string." (let ((case-fold-search t) (titlestring (bibtex-autokey-get-field "title" @@ -2866,7 +2866,7 @@ Concatenate the key: (defun bibtex-read-key (prompt &optional key global) "Read BibTeX key from minibuffer using PROMPT and default KEY. If optional arg GLOBAL is non-nil, completion is based on the keys in -`bibtex-reference-keys' of `bibtex-files'," +`bibtex-reference-keys' of `bibtex-files'." (let (completion-ignore-case) (completing-read prompt (if global (bibtex-global-key-alist) bibtex-reference-keys) @@ -3054,7 +3054,7 @@ already set. If SELECT is non-nil interactively select a BibTeX buffer. When called interactively, FORCE is t, CURRENT is t if current buffer visits a file using `bibtex-mode', and SELECT is t if current buffer -does not use `bibtex-mode'," +does not use `bibtex-mode'." (interactive (list (eq major-mode 'bibtex-mode) t (not (eq major-mode 'bibtex-mode)))) (let ((file-path (split-string (or bibtex-file-path default-directory) ":+")) diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index bfe912308e9..bae0283497e 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -1116,7 +1116,7 @@ Mostly we check word delimiters." If the optional argument FOLLOWING, or, when called interactively `ispell-following-word', is non-nil, checks the following (rather than preceding) word when the cursor is not over a word. If -optional argument KNOWN-MISSPELLING is non nil considers word a +optional argument KNOWN-MISSPELLING is non-nil considers word a misspelling and skips redundant spell-checking step. See `flyspell-get-word' for details of how this finds the word to diff --git a/lisp/view.el b/lisp/view.el index deda061cd39..f9aa86617a4 100644 --- a/lisp/view.el +++ b/lisp/view.el @@ -581,7 +581,7 @@ the associations of any windows with the current buffer. EXIT-ACTION, if non-nil, must specify a function that is called with the current buffer as argument and is called after disabling `view-mode' and removing any associations of windows with the -current buffer. " +current buffer." (when view-mode (let ((buffer (window-buffer))) (unless view-no-disable-on-exit diff --git a/src/composite.c b/src/composite.c index efbd055cef2..2725ab3b99c 100644 --- a/src/composite.c +++ b/src/composite.c @@ -77,7 +77,7 @@ along with GNU Emacs. If not, see . */ composition, the elements are characters or encoded composition rules. - MODIFICATION-FUNC -- If non nil, it is a function to call when the + MODIFICATION-FUNC -- If non-nil, it is a function to call when the composition gets invalid after a modification in a buffer. If it is nil, a function in `composition-function-table' of the first character in the sequence is called. diff --git a/src/floatfns.c b/src/floatfns.c index 9049185307c..3199d572138 100644 --- a/src/floatfns.c +++ b/src/floatfns.c @@ -141,7 +141,7 @@ DEFUN ("tan", Ftan, Stan, 1, 1, 0, } DEFUN ("isnan", Fisnan, Sisnan, 1, 1, 0, - doc: /* Return non nil if argument X is a NaN. */) + doc: /* Return non-nil if argument X is a NaN. */) (Lisp_Object x) { CHECK_FLOAT (x);