[elpa] externals/ada-mode 2d17566 21/48: Fix some quoting problems in doc strings

[Stefan Monnier]

branch: externals/ada-mode
commit 2d17566a3c452ffcc1774d2fd4e025f70ad9b0bf
Author: Paul Eggert <eggert@cs.ucla.edu>
Commit: Paul Eggert <eggert@cs.ucla.edu>

    Fix some quoting problems in doc strings
    
    Most of these are minor issues involving, e.g., quoting `like this'
    instead of 'like this'.  A few involve escaping ` and ' with a
    preceding \= when the characters should not be turned into curved single
    quotes.
---
 ada-build.el               | 14 +++++++-------
 ada-fix-error.el           |  6 +++---
 ada-gnat-compile.el        |  2 +-
 ada-gnat-xref.el           |  4 ++--
 ada-indent-user-options.el | 18 +++++++++---------
 ada-mode.el                | 20 ++++++++++----------
 gnat-core.el               |  2 +-
 gpr-query.el               |  4 ++--
 8 files changed, 35 insertions(+), 35 deletions(-)

diff --git a/ada-build.el b/ada-build.el
index 0553454..158773a 100644
--- a/ada-build.el
+++ b/ada-build.el
@@ -60,14 +60,14 @@
 (defcustom ada-build-check-cmd
   (concat "${cross_prefix}gnatmake -u -c -gnatc ${gnatmake_opt} 
${full_current} -cargs -I${src_dir} ${comp_opt}")
   "Default command to syntax check a single file.
-Overridden by project variable 'check_cmd'."
+Overridden by project variable `check_cmd'."
   :type 'string)
 
 (defcustom ada-build-make-cmd
   (concat "${cross_prefix}gnatmake -P${gpr_file} -o ${main} ${main} 
${gnatmake_opt} "
          "-cargs -I${src_dir} ${comp_opt} -bargs ${bind_opt} -largs 
${link_opt}")
   "Default command to compile the application.
-Overridden by project variable 'make_cmd'."
+Overridden by project variable `make_cmd'."
   :type 'string)
 
 ;; FIXME: make this more intelligent to work on Windows cmd shell?
@@ -75,7 +75,7 @@ Overridden by project variable 'make_cmd'."
 ;; runtime.
 (defcustom ada-build-run-cmd "./${main}"
   "Default command to run the application, in a spawned shell.
-Overridden by project variable 'run_cmd'."
+Overridden by project variable `run_cmd'."
   :type 'string)
 
 ;;;; code
@@ -85,11 +85,11 @@ Overridden by project variable 'run_cmd'."
 ${var} is a project variable or environment variable, $var an
 environment variable.
 
-A prefix may be specified with the format '-<prefix>${var}'; then
+A prefix may be specified with the format `-<prefix>${var}'; then
 the value is expanded with the prefix prepended. If the value is
 a list, the prefix is prepended to each list element. For
-example, if src_dir contains 'dir_1 dir_2', '-I${src_dir}'
-expands to '-Idir_1 -Idir_2'.
+example, if src_dir contains `dir_1 dir_2', `-I${src_dir}'
+expands to `-Idir_1 -Idir_2'.
 
 As a special case, ${full_current} is replaced by the current
 buffer file name including the directory and extension."
@@ -153,7 +153,7 @@ buffer file name including the directory and extension."
 (defun ada-build-find-select-prj-file ()
   "Search for a project file in the current directory, parse and select it.
 The file must have the same basename as the project variable
-'main' or the current buffer if 'main' is nil, and extension from
+`main' or the current buffer if `main' is nil, and extension from
 `ada-prj-file-extensions'.  Returns non-nil if a file is
 selected, nil otherwise."
   (let* ((base-file-name (file-name-base
diff --git a/ada-fix-error.el b/ada-fix-error.el
index 6ec0fd7..130bb3e 100644
--- a/ada-fix-error.el
+++ b/ada-fix-error.el
@@ -31,7 +31,7 @@
 (require 'compile)
 
 (defcustom ada-fix-sort-context-clause t
-  "*If non-nil, sort context clause when inserting 'with'"
+  "*If non-nil, sort context clause when inserting `with'"
   :type 'boolean
   :group 'ada)
 
@@ -155,7 +155,7 @@ extend a with_clause to include CHILD-NAME  .       "
       )))
 
 (defun ada-fix-add-use-type (type)
-  "Insert 'use type' clause for TYPE at start of declarative part for current 
construct."
+  "Insert `use type' clause for TYPE at start of declarative part for current 
construct."
   (ada-goto-declarative-region-start); leaves point after 'is'
   (newline)
   (insert "use type " type ";")
@@ -164,7 +164,7 @@ extend a with_clause to include CHILD-NAME  .       "
   (indent-according-to-mode))
 
 (defun ada-fix-add-use (package)
-  "Insert 'use' clause for PACKAGE at start of declarative part for current 
construct."
+  "Insert `use' clause for PACKAGE at start of declarative part for current 
construct."
   (ada-goto-declarative-region-start); leaves point after 'is'
   (newline)
   (insert "use " package ";")
diff --git a/ada-gnat-compile.el b/ada-gnat-compile.el
index ee4b12a..c0d2156 100644
--- a/ada-gnat-compile.el
+++ b/ada-gnat-compile.el
@@ -616,7 +616,7 @@ Prompt user if more than one."
   )
 
 (defun ada-gnat-compile ()
-  "Set Ada mode global vars to use 'gnat' for compiling."
+  "Set Ada mode global vars to use `gnat' for compiling."
   (add-to-list 'ada-prj-file-ext-extra     "gpr")
   (add-to-list 'ada-prj-parser-alist       '("gpr" . gnat-parse-gpr))
   (add-to-list 'ada-select-prj-compiler    '(gnat  . 
ada-gnat-compile-select-prj))
diff --git a/ada-gnat-xref.el b/ada-gnat-xref.el
index 53553b3..4d49aa7 100644
--- a/ada-gnat-xref.el
+++ b/ada-gnat-xref.el
@@ -44,7 +44,7 @@
 (defconst ada-gnat-file-line-col-regexp "\\(.*\\):\\([0-9]+\\):\\([0-9]+\\)")
 
 (defun ada-gnat-xref-other (identifier file line col)
-  "For `ada-xref-other-function', using 'gnat find', which is Ada-specific."
+  "For `ada-xref-other-function', using `gnat find', which is Ada-specific."
 
   (when (eq ?\" (aref identifier 0))
     ;; gnat find wants the quotes on operators, but the column is after the 
first quote.
@@ -93,7 +93,7 @@
     result))
 
 (defun ada-gnat-xref-parents (identifier file line col)
-  "For `ada-xref-parents-function', using 'gnat find', which is Ada-specific."
+  "For `ada-xref-parents-function', using `gnat find', which is Ada-specific."
 
   (let* ((arg (format "%s:%s:%d:%d" identifier file line col))
         (switches (list
diff --git a/ada-indent-user-options.el b/ada-indent-user-options.el
index 1be01cd..267ac41 100644
--- a/ada-indent-user-options.el
+++ b/ada-indent-user-options.el
@@ -110,7 +110,7 @@ Example :
 (make-variable-buffer-local 'ada-indent-label)
 
 (defcustom ada-indent-record-rel-type 3
-  "Indentation for 'record' relative to 'type' or 'use'.
+  "Indentation for `record' relative to `type' or `use'.
 
 An example is:
    type A is
@@ -120,9 +120,9 @@ An example is:
 (make-variable-buffer-local 'ada-indent-record-rel-type)
 
 (defcustom ada-indent-renames 2
-  "Indentation for 'renames' relative to the matching subprogram keyword.
+  "Indentation for `renames' relative to the matching subprogram keyword.
 
-For 'renames' of non-subprograms the indentation is
+For `renames' of non-subprograms the indentation is
 `ada-indent-broken' relative to the line containing the matching
 keyword.
 
@@ -149,15 +149,15 @@ Examples:
 (make-variable-buffer-local 'ada-indent-renames)
 
 (defcustom ada-indent-return 0
-  "Indentation for 'return' relative to the matching 'function' keyword.
+  "Indentation for `return' relative to the matching `function' keyword.
 
 If the function has parameters, then if `ada-indent-return' is
 zero or less the indentation is abs `ada-indent-return' relative
 to the open parenthesis; if `ada-indent-return' is one or more,
-indentation is relative to line containing 'function'.
+indentation is relative to line containing `function'.
 
 If the function has no parameters, `ada-indent-broken' is used
-relative to line containing 'function'.
+relative to line containing `function'.
 
 An example is:
    function A (B : Integer)
@@ -178,7 +178,7 @@ An example is:
        (message "WARNING: setting `ada-indent-use' to obsolete 
`ada-use-indent'")
        ada-use-indent)
       ada-indent-broken)
-  "Indentation for the lines in a 'use' statement.
+  "Indentation for the lines in a `use' statement.
 
 An example is:
    use Ada.Text_IO,
@@ -199,7 +199,7 @@ An example is:
        (message "WARNING: setting `ada-indent-when' to obsolete 
`ada-when-indent'")
        ada-when-indent)
       3)
-  "Indentation for 'when' relative to 'exception', 'case', 'or' in select.
+  "Indentation for `when' relative to `exception', `case', `or' in select.
 
 An example is:
    case A is
@@ -220,7 +220,7 @@ An example is:
        (message "WARNING: setting `ada-indent-with' to obsolete 
`ada-with-indent'")
        ada-with-indent)
       ada-indent-broken)
-  "Indentation for the lines in a 'with' context clause.
+  "Indentation for the lines in a `with' context clause.
 
 An example is:
    with Ada.Text_IO,
diff --git a/ada-mode.el b/ada-mode.el
index 8fb112a..b8d2aff 100644
--- a/ada-mode.el
+++ b/ada-mode.el
@@ -201,7 +201,7 @@ identifiers are Mixed_Case."
 
 (defcustom ada-case-exception-file nil
   "Default list of special casing exceptions dictionaries for identifiers.
-Override with 'casing' project variable.
+Override with `casing' project variable.
 
 New exceptions may be added interactively via `ada-case-create-exception'.
 If an exception is defined in multiple files, the first occurence is used.
@@ -597,7 +597,7 @@ Placeholders are defined by the skeleton backend."
   "See the variable `align-region-separate' for more information.")
 
 (defun ada-align ()
-  "If region is active, apply 'align'. If not, attempt to align
+  "If region is active, apply `align'. If not, attempt to align
 current construct."
   (interactive)
   (if (use-region-p)
@@ -661,7 +661,7 @@ Function is called with one optional argument; syntax-ppss 
result.")
   "Function to scan a region, return a list of subprogram parameter 
declarations (in inverse declaration order).
 Function is called with two args BEGIN END (the region).
 Each parameter declaration is represented by a list
-'((identifier ...) aliased-p in-p out-p not-null-p access-p constant-p 
protected-p type default)."
+((identifier ...) aliased-p in-p out-p not-null-p access-p constant-p 
protected-p type default)."
   ;; Summary of Ada syntax for a parameter specification:
   ;; ... : [aliased] {[in] | out | in out | [null_exclusion] access [constant 
| protected]} ...
   )
@@ -1169,7 +1169,7 @@ Uses `ada-case-identifier', with exceptions defined in
 
 (defun ada-case-adjust-keyword ()
   "Adjust the case of the previous word as a keyword.
-'word' here is allowed to be underscore-separated (GPR external_as_list)."
+`word' here is allowed to be underscore-separated (GPR external_as_list)."
   (save-excursion
     (let ((end   (point-marker))
          (start (progn (skip-syntax-backward "w_") (point))))
@@ -2233,8 +2233,8 @@ Function is called with four arguments:
 - filename containing the identifier (full path)
 - line number containing the identifier
 - column of the start of the identifier
-Returns a list '(file line column) giving the corresponding location.
-'file' may be absolute, or on `compilation-search-path'.  If point is
+Returns a list (FILE LINE COLUMN) giving the corresponding location.
+FILE may be absolute, or on `compilation-search-path'.  If point is
 at the specification, the corresponding location is the body, and vice
 versa.")
 
@@ -2348,8 +2348,8 @@ Called with four arguments:
 - filename containing the identifier
 - line number containing the identifier
 - column of the start of the identifier
-Returns a list '(file line column) giving the corresponding location.
-'file' may be absolute, or on `compilation-search-path'.")
+Returns a list (FILE LINE COLUMN) giving the corresponding location.
+FILE may be absolute, or on `compilation-search-path'.")
 
 (defun ada-show-overridden (other-window)
   "Show the overridden declaration of identifier at point."
@@ -2486,7 +2486,7 @@ is currently in.  Called with no parameters.")
   ;; Supplied by indentation engine
   "Function called with no parameters; it should move forward to
 the next keyword in the statement following the one point is
-in (ie from 'if' to 'then'). If not in a keyword, move forward to
+in (ie from `if' to `then'). If not in a keyword, move forward to
 the next keyword in the current statement. If at the last
 keyword, move forward to the first keyword in the next statement
 or next keyword in the containing statement.")
@@ -2520,7 +2520,7 @@ if on open parenthesis move to matching closing 
parenthesis."
   ;; Supplied by indentation engine
   "Function called with no parameters; it should move to the previous
 keyword in the statement following the one point is in (ie from
-'then' to 'if').  If at the first keyword, move to the previous
+`then' to `if').  If at the first keyword, move to the previous
 keyword in the previous statement or containing statement.")
 
 (defun ada-prev-statement-keyword ()
diff --git a/gnat-core.el b/gnat-core.el
index f8d4f31..ea4163e 100644
--- a/gnat-core.el
+++ b/gnat-core.el
@@ -109,7 +109,7 @@ See also `gnat-parse-emacs-final'."
 
 (defun gnat-get-paths-1 (src-dirs prj-dirs)
   "Append list of source and project dirs in current gpr project to SRC-DIRS, 
PRJ-DIRS.
-Uses 'gnat list'.  Returns new (SRC-DIRS PRJ-DIRS)."
+Uses `gnat list'.  Returns new (SRC-DIRS PRJ-DIRS)."
   (with-current-buffer (gnat-run-buffer)
     ;; gnat list -v -P can return status 0 or 4; always lists compiler dirs
     ;;
diff --git a/gpr-query.el b/gpr-query.el
index ccb980e..c22a077 100644
--- a/gpr-query.el
+++ b/gpr-query.el
@@ -195,7 +195,7 @@ Return buffer that holds output."
 
 (defun gpr-query-get-src-dirs (src-dirs)
   "Append list of source dirs in current gpr project to SRC-DIRS.
-Uses 'gpr_query'. Returns new list."
+Uses `gpr_query'. Returns new list."
 
   (with-current-buffer (gpr-query--session-buffer (gpr-query-cached-session))
     (gpr-query-session-send "source_dirs" t)
@@ -210,7 +210,7 @@ Uses 'gpr_query'. Returns new list."
 
 (defun gpr-query-get-prj-dirs (prj-dirs)
   "Append list of project dirs in current gpr project to PRJ-DIRS.
-Uses 'gpr_query'. Returns new list."
+Uses `gpr_query'. Returns new list."
 
   (with-current-buffer (gpr-query--session-buffer (gpr-query-cached-session))
     (gpr-query-session-send "project_path" t)