summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2016-10-31 10:01:33 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2016-10-31 10:01:33 +0100
commit1d7150319b528787b46250646e56d06004dc767d (patch)
tree27baf69f53313fc53e29f9593d34c6f6da9e4a93
parent21932c15d3586c66a5e8ff6f875831830665c54b (diff)
downloadorg-mode-1d7150319b528787b46250646e56d06004dc767d.tar.gz
Fix docstrings
* lisp/org-clock.el (org-clock-get-table-data): * lisp/org-element.el (org-element--cache-objects): (org-element--cache-generate-key): * lisp/org-footnote.el (org-footnote--collect-references): * lisp/org-list.el (org-list-to-lisp): * lisp/org-table.el (orgtbl-to-generic): * lisp/org.el (org-file-apps): (org-execute-file-search-functions): (org-after-todo-statistics-hook): (org-find-olp): * lisp/ox-html.el (org-html-table-row-open-tag): Do not escape parenthesis in docstring when not at column 0.
-rw-r--r--lisp/org-clock.el2
-rw-r--r--lisp/org-element.el20
-rw-r--r--lisp/org-footnote.el4
-rw-r--r--lisp/org-list.el12
-rw-r--r--lisp/org-table.el2
-rw-r--r--lisp/org.el18
-rw-r--r--lisp/ox-html.el18
7 files changed, 38 insertions, 38 deletions
diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index c14d097..b148a08 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -2749,7 +2749,7 @@ file time (in minutes) as 1st and 2nd elements. The third element
of this list will be a list of headline entries. Each entry has the
following structure:
- \(LEVEL HEADLINE TIMESTAMP TIME)
+ (LEVEL HEADLINE TIMESTAMP TIME)
LEVEL: The level of the headline, as an integer. This will be
the reduced level, so 1,2,3,... even if only odd levels
diff --git a/lisp/org-element.el b/lisp/org-element.el
index 008dddc..027eea4 100644
--- a/lisp/org-element.el
+++ b/lisp/org-element.el
@@ -4821,7 +4821,7 @@ with `org-element--cache-compare'. This cache is used in
Key is an element, as returned by `org-element-at-point', and
value is an alist where each association is:
- \(PARENT COMPLETEP . OBJECTS)
+ (PARENT COMPLETEP . OBJECTS)
where PARENT is an element or object, COMPLETEP is a boolean,
non-nil when all direct children of parent are already cached and
@@ -4835,12 +4835,12 @@ contained within a paragraph
If the paragraph is completely parsed, OBJECTS-DATA will be
- \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
- \(BOLD-OBJECT t ENTITY-OBJECT))
+ ((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
+ (BOLD-OBJECT t ENTITY-OBJECT))
whereas in a partially parsed paragraph, it could be
- \((PARAGRAPH nil ENTITY-OBJECT))
+ ((PARAGRAPH nil ENTITY-OBJECT))
This cache is used in `org-element-context'.")
@@ -4929,16 +4929,16 @@ the following rules:
gets a new level. Its value is the mean between LOWER and
UPPER:
- \(1 2) + (1 4) --> (1 3)
+ (1 2) + (1 4) --> (1 3)
- If LOWER has no value to compare with, it is assumed that its
value is `most-negative-fixnum'. E.g.,
- \(1 1) + (1 1 2)
+ (1 1) + (1 1 2)
is equivalent to
- \(1 1 m) + (1 1 2)
+ (1 1 m) + (1 1 2)
where m is `most-negative-fixnum'. Likewise, if UPPER is
short of levels, the current value is `most-positive-fixnum'.
@@ -4946,18 +4946,18 @@ the following rules:
- If they differ from only one, the new key inherits from
current LOWER level and fork it at the next level. E.g.,
- \(2 1) + (3 3)
+ (2 1) + (3 3)
is equivalent to
- \(2 1) + (2 M)
+ (2 1) + (2 M)
where M is `most-positive-fixnum'.
- If the key is only one level long, it is returned as an
integer:
- \(1 2) + (3 2) --> 2
+ (1 2) + (3 2) --> 2
When they are not equals, the function assumes that LOWER is
lesser than UPPER, per `org-element--cache-key-less-p'."
diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index 9e6bd9c..5b60a19 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -349,7 +349,7 @@ to rename."
Return an alist where associations follow the pattern
- \(LABEL MARKER TOP-LEVEL SIZE)
+ (LABEL MARKER TOP-LEVEL SIZE)
with
@@ -414,7 +414,7 @@ References are sorted according to a deep-reading order."
Return an alist where associations follow the pattern
- \(LABEL . DEFINITION)
+ (LABEL . DEFINITION)
with LABEL and DEFINITION being, respectively, the label and the
definition of the footnote, as strings.
diff --git a/lisp/org-list.el b/lisp/org-list.el
index 83f22c6..e8d9aef 100644
--- a/lisp/org-list.el
+++ b/lisp/org-list.el
@@ -3109,13 +3109,13 @@ For example, the following list:
is parsed as
- \(ordered
- \(\"first item\"
- \(unordered
- \(\"sub-item one\")
- \(\"[X] sub-item two\"))
+ (ordered
+ (\"first item\"
+ (unordered
+ (\"sub-item one\")
+ (\"[X] sub-item two\"))
\"more text in first item\")
- \(\"[@3] last item\"))
+ (\"[@3] last item\"))
Point is left at list's end."
(letrec ((struct (org-list-struct))
diff --git a/lisp/org-table.el b/lisp/org-table.el
index 6dcf107..e2bbe87 100644
--- a/lisp/org-table.el
+++ b/lisp/org-table.el
@@ -4815,7 +4815,7 @@ strings, or the current cell) returning a string:
a property list with column numbers and format strings, or
functions, e.g.,
- \(:fmt (2 \"$%s$\" 4 (lambda (c) (format \"$%s$\" c))))
+ (:fmt (2 \"$%s$\" 4 (lambda (c) (format \"$%s$\" c))))
:hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
diff --git a/lisp/org.el b/lisp/org.el
index 5de4b68..3c72a4a 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -2300,7 +2300,7 @@ Possible values for the file identifier are:
handled identically to the second one (i.e. match against
file name only).
In a custom function, you can access the group matches with
- \(match-string n link).
+ (match-string n link).
Example: (\"\\\\.pdf::\\\\(\\\\d+\\\\)\\\\\\='\" . \
\"evince -p %1 %s\")
@@ -2314,7 +2314,7 @@ Possible values for the file identifier are:
so all files Emacs knows how to handle. Using this with
command `emacs' will open most files in Emacs. Beware that this
will also open html files inside Emacs, unless you add
- \(\"html\" . default) to the list as well.
+ (\"html\" . default) to the list as well.
`system' The system command to open files, like `open' on Windows
and Mac OS X, and mailcap under GNU/Linux. This is the command
that will be selected if you call `org-open-at-point' with a
@@ -11087,7 +11087,7 @@ numeric or double prefix to guide the search function.
In case this is needed, a function in this hook can also restore
the window configuration before `org-open-at-point' was called using:
- \(set-window-configuration org-window-config-before-follow-link)")
+ (set-window-configuration org-window-config-before-follow-link)")
(defun org-search-radio-target (target)
"Search a radio target matching TARGET in current buffer.
@@ -13090,10 +13090,10 @@ an entry to DONE when all children are done, and back to TODO when new
entries are set to a TODO status. Note that this hook is only called
when there is a statistics cookie in the headline!
- \(defun org-summary-todo (n-done n-not-done)
+ (defun org-summary-todo (n-done n-not-done)
\"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
- \(let (org-log-done org-log-states) ; turn off logging
- \(org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
+ (let (org-log-done org-log-states) ; turn off logging
+ (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
")
(defvar org-todo-statistics-hook nil
@@ -16670,9 +16670,9 @@ completion."
If anything goes wrong, throw an error.
You can wrap this call to catch the error like this:
- \(condition-case msg
- \(org-mobile-locate-entry (match-string 4))
- \(error (nth 1 msg)))
+ (condition-case msg
+ (org-mobile-locate-entry (match-string 4))
+ (error (nth 1 msg)))
The return value will then be either a string with the error message,
or a marker if everything is OK.
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index c699e26..404b62f 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -948,18 +948,18 @@ The function will be called with these arguments:
`number': row number (0 is the first row)
`group-number': group number of current row
- `start-group-p': non-nil means the row starts a group
- `end-group-p': non-nil means the row ends a group
- `topp': non-nil means this is the top row
- `bottomp': non-nil means this is the bottom row
+ `start-group?': non-nil means the row starts a group
+ `end-group?': non-nil means the row ends a group
+ `top?': non-nil means this is the top row
+ `bottom?': non-nil means this is the bottom row
For example:
- \(setq org-html-table-row-open-tag
- \(lambda (number group-number start-group-p end-group-p topp bottomp)
- \(cond (topp \"<tr class=\\\"tr-top\\\">\")
- \(bottomp \"<tr class=\\\"tr-bottom\\\">\")
- \(t (if (= (mod number 2) 1)
+ (setq org-html-table-row-open-tag
+ (lambda (number group-number start-group? end-group-p top? bottom?)
+ (cond (top? \"<tr class=\\\"tr-top\\\">\")
+ (bottom? \"<tr class=\\\"tr-bottom\\\">\")
+ (t (if (= (mod number 2) 1)
\"<tr class=\\\"tr-odd\\\">\"
\"<tr class=\\\"tr-even\\\">\")))))