Escape ` and ' in doc

Escape apostrophes and grave accents in docstrings if they are
are supposed to stand for themselves and are not quotes.  Remove
apostrophes from docstring examples like ‘'(calendar-nth-named-day
-1 0 10 year)’ that confuse source code with data.  Do some other
minor docstring fixups as well, e.g., insert a missing close
quote.
This commit is contained in:
Paul Eggert 2015-09-01 18:21:42 -07:00
parent 5dc644a6b0
commit 19532d147b
43 changed files with 127 additions and 128 deletions

View file

@ -1990,8 +1990,8 @@ the lower-case version of all tags."
"Alist of characters and custom functions for bulk actions.
For example, this value makes those two functions available:
'((?R set-category)
(?C bulk-cut))
((?R set-category)
(?C bulk-cut))
With selected entries in an agenda buffer, `B R' will call
the custom function `set-category' on the selected entries.
@ -4937,13 +4937,13 @@ the `regexp' or `notregexp' element.
`todo' and `nottodo' accept as an argument a list of todo
keywords, which may include \"*\" to match any todo keyword.
(org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
(org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
would skip all entries with \"TODO\" or \"WAITING\" keywords.
Instead of a list, a keyword class may be given. For example:
(org-agenda-skip-entry-if 'nottodo 'done)
(org-agenda-skip-entry-if \\='nottodo \\='done)
would skip entries that haven't been marked with any of \"DONE\"
keywords. Possible classes are: `todo', `done', `any'.
@ -10005,10 +10005,10 @@ calling the function returns nil. This function takes one
argument: an entry from `org-agenda-get-day-entries'.
FILTER can also be an alist with the car of each cell being
either 'headline or 'category. For example:
either `headline' or `category'. For example:
'((headline \"IMPORTANT\")
(category \"Work\"))
((headline \"IMPORTANT\")
(category \"Work\"))
will only add headlines containing IMPORTANT or headlines
belonging to the \"Work\" category.

View file

@ -197,7 +197,7 @@ Possible properties are:
Example:
(setq org-protocol-project-alist
'((\"http://orgmode.org/worg/\"
\\='((\"http://orgmode.org/worg/\"
:online-suffix \".php\"
:working-suffix \".org\"
:base-url \"http://orgmode.org/worg/\"
@ -251,7 +251,7 @@ kill-client - If t, kill the client immediately, once the sub-protocol is
Here is an example:
(setq org-protocol-protocol-alist
'((\"my-protocol\"
\\='((\"my-protocol\"
:protocol \"my-protocol\"
:function my-protocol-handler-function)
(\"your-protocol\"

View file

@ -833,7 +833,7 @@ you can reuse them:
For example:
\(setq org-html-table-row-tags
(cons '(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
(cons \\='(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
(bottom-row-p \"<tr class=\\\"tr-bottom\\\">\")
(t (if (= (mod row-number 2) 1)
\"<tr class=\\\"tr-odd\\\">\"