ソースを参照

org-element: Fix docstring and code typos

Nicolas Goaziou 11 年 前
コミット
39cfc39ccb
1 ファイル変更16 行追加16 行削除
  1. 16 16
      lisp/org-element.el

+ 16 - 16
lisp/org-element.el

@@ -62,7 +62,7 @@
 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
 ;;
 ;;
 ;; Some elements also have special properties whose value can hold
 ;; Some elements also have special properties whose value can hold
-;; objects themselves (i.e. an item tag or a headline name).  Such
+;; objects themselves (e.g. an item tag or a headline name).  Such
 ;; values are called "secondary strings".  Any object belongs to
 ;; values are called "secondary strings".  Any object belongs to
 ;; either an element or a secondary string.
 ;; either an element or a secondary string.
 ;;
 ;;
@@ -236,7 +236,7 @@ application to open them.")
   '("CAPTION" "DATA" "HEADER" "HEADERS" "LABEL" "NAME" "PLOT" "RESNAME" "RESULT"
   '("CAPTION" "DATA" "HEADER" "HEADERS" "LABEL" "NAME" "PLOT" "RESNAME" "RESULT"
     "RESULTS" "SOURCE" "SRCNAME" "TBLNAME")
     "RESULTS" "SOURCE" "SRCNAME" "TBLNAME")
   "List of affiliated keywords as strings.
   "List of affiliated keywords as strings.
-By default, all keywords setting attributes (i.e. \"ATTR_LATEX\")
+By default, all keywords setting attributes (e.g., \"ATTR_LATEX\")
 are affiliated keywords and need not to be in this list.")
 are affiliated keywords and need not to be in this list.")
 
 
 (defconst org-element-keyword-translation-alist
 (defconst org-element-keyword-translation-alist
@@ -256,7 +256,7 @@ returned as the value of the property.
 This list is checked after translations have been applied.  See
 This list is checked after translations have been applied.  See
 `org-element-keyword-translation-alist'.
 `org-element-keyword-translation-alist'.
 
 
-By default, all keywords setting attributes (i.e. \"ATTR_LATEX\")
+By default, all keywords setting attributes (e.g., \"ATTR_LATEX\")
 allow multiple occurrences and need not to be in this list.")
 allow multiple occurrences and need not to be in this list.")
 
 
 (defconst org-element-parsed-keywords '("CAPTION")
 (defconst org-element-parsed-keywords '("CAPTION")
@@ -739,7 +739,7 @@ containing `:raw-value', `:title', `:alt-title', `:begin',
 
 
 The plist also contains any property set in the property drawer,
 The plist also contains any property set in the property drawer,
 with its name in upper cases and colons added at the
 with its name in upper cases and colons added at the
-beginning (i.e. `:CUSTOM_ID').
+beginning (e.g., `:CUSTOM_ID').
 
 
 When RAW-SECONDARY-P is non-nil, headline's title will not be
 When RAW-SECONDARY-P is non-nil, headline's title will not be
 parsed as a secondary string, but as a plain string instead.
 parsed as a secondary string, but as a plain string instead.
@@ -922,7 +922,7 @@ containing `:title', `:begin', `:end', `:hiddenp',
 
 
 The plist also contains any property set in the property drawer,
 The plist also contains any property set in the property drawer,
 with its name in upper cases and colons added at the
 with its name in upper cases and colons added at the
-beginning (i.e. `:CUSTOM_ID').
+beginning (e.g., `:CUSTOM_ID').
 
 
 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
 title will not be parsed as a secondary string, but as a plain
 title will not be parsed as a secondary string, but as a plain
@@ -2150,8 +2150,8 @@ Assume point is at the beginning of the paragraph."
 		;; A matching `org-element-paragraph-separate' is not
 		;; A matching `org-element-paragraph-separate' is not
 		;; necessarily the end of the paragraph.  In
 		;; necessarily the end of the paragraph.  In
 		;; particular, lines starting with # or : as a first
 		;; particular, lines starting with # or : as a first
-		;; non-space character are ambiguous.  We have check
-		;; if they are valid Org syntax (i.e. not an
+		;; non-space character are ambiguous.  We have to
+		;; check if they are valid Org syntax (e.g., not an
 		;; incomplete keyword).
 		;; incomplete keyword).
 		(beginning-of-line)
 		(beginning-of-line)
 		(while (not
 		(while (not
@@ -2589,8 +2589,8 @@ CONTENTS is verse block contents."
 ;;
 ;;
 ;; Unlike to elements, interstices can be found between objects.
 ;; Unlike to elements, interstices can be found between objects.
 ;; That's why, along with the parser, successor functions are provided
 ;; That's why, along with the parser, successor functions are provided
-;; for each object.  Some objects share the same successor (i.e. `code'
-;; and `verbatim' objects).
+;; for each object.  Some objects share the same successor (e.g.,
+;; `code' and `verbatim' objects).
 ;;
 ;;
 ;; A successor must accept a single argument bounding the search.  It
 ;; A successor must accept a single argument bounding the search.  It
 ;; will return either a cons cell whose CAR is the object's type, as
 ;; will return either a cons cell whose CAR is the object's type, as
@@ -2600,7 +2600,7 @@ CONTENTS is verse block contents."
 ;; org-element-NAME-successor, where NAME is the name of the
 ;; org-element-NAME-successor, where NAME is the name of the
 ;; successor, as defined in `org-element-all-successors'.
 ;; successor, as defined in `org-element-all-successors'.
 ;;
 ;;
-;; Some object types (i.e. `italic') are recursive.  Restrictions on
+;; Some object types (e.g., `italic') are recursive.  Restrictions on
 ;; object types they can contain will be specified in
 ;; object types they can contain will be specified in
 ;; `org-element-object-restrictions'.
 ;; `org-element-object-restrictions'.
 ;;
 ;;
@@ -3099,7 +3099,7 @@ Assume point is at the beginning of the link."
 	      link-end contents-end
 	      link-end contents-end
 	      raw-link (org-match-string-no-properties 0)
 	      raw-link (org-match-string-no-properties 0)
 	      path (downcase raw-link)))
 	      path (downcase raw-link)))
-       ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
+       ;; Type 2: Standard link, e.g. [[http://orgmode.org][homepage]]
        ((looking-at org-bracket-link-regexp)
        ((looking-at org-bracket-link-regexp)
 	(setq contents-begin (match-beginning 3)
 	(setq contents-begin (match-beginning 3)
 	      contents-end (match-end 3)
 	      contents-end (match-end 3)
@@ -3131,13 +3131,13 @@ Assume point is at the beginning of the link."
 	 ;; headline name or nothing.  PATH is the target or
 	 ;; headline name or nothing.  PATH is the target or
 	 ;; headline's name.
 	 ;; headline's name.
 	 (t (setq type "fuzzy" path raw-link))))
 	 (t (setq type "fuzzy" path raw-link))))
-       ;; Type 3: Plain link, i.e. http://orgmode.org
+       ;; Type 3: Plain link, e.g., http://orgmode.org
        ((looking-at org-plain-link-re)
        ((looking-at org-plain-link-re)
 	(setq raw-link (org-match-string-no-properties 0)
 	(setq raw-link (org-match-string-no-properties 0)
 	      type (org-match-string-no-properties 1)
 	      type (org-match-string-no-properties 1)
 	      link-end (match-end 0)
 	      link-end (match-end 0)
 	      path (org-match-string-no-properties 2)))
 	      path (org-match-string-no-properties 2)))
-       ;; Type 4: Angular link, i.e. <http://orgmode.org>
+       ;; Type 4: Angular link, e.g., <http://orgmode.org>
        ((looking-at org-angle-link-re)
        ((looking-at org-angle-link-re)
 	(setq raw-link (buffer-substring-no-properties
 	(setq raw-link (buffer-substring-no-properties
 			(match-beginning 1) (match-end 2))
 			(match-beginning 1) (match-end 2))
@@ -3814,8 +3814,8 @@ CONTENTS is nil."
 ;; point.
 ;; point.
 ;;
 ;;
 ;; `org-element--current-element' makes use of special modes.  They
 ;; `org-element--current-element' makes use of special modes.  They
-;; are activated for fixed element chaining (i.e. `plain-list' >
-;; `item') or fixed conditional element chaining (i.e. `headline' >
+;; are activated for fixed element chaining (e.g., `plain-list' >
+;; `item') or fixed conditional element chaining (e.g., `headline' >
 ;; `section').  Special modes are: `first-section', `item',
 ;; `section').  Special modes are: `first-section', `item',
 ;; `node-property', `quote-section', `section' and `table-row'.
 ;; `node-property', `quote-section', `section' and `table-row'.
 
 
@@ -3959,7 +3959,7 @@ CDR a plist of keywords and values and move point to the
 beginning of the first line after them.
 beginning of the first line after them.
 
 
 As a special case, if element doesn't start at the beginning of
 As a special case, if element doesn't start at the beginning of
-the line (i.e. a paragraph starting an item), CAR is current
+the line (e.g., a paragraph starting an item), CAR is current
 position of point and CDR is nil."
 position of point and CDR is nil."
   (if (not (bolp)) (list (point))
   (if (not (bolp)) (list (point))
     (let ((case-fold-search t)
     (let ((case-fold-search t)