Re: Docstring fixes

[Stephen J. Eglen]

and a commit message.

org.el: Docstring fixes.

* lisp/org.el (org-hide-emphasis-markers)
(org-hide-macro-markers)
(org-pretty-entities-include-sub-superscripts): Follow elisp
convention for docstrings: 'Non-nil means ...'.



On Sat, Mar 25 2023, Stephen J. Eglen wrote:

> Some small docstring fixes to align with convention in Emacs for
> 'Non-nil means ...'
>
> Stephen
>
> diff --git a/lisp/org.el b/lisp/org.el
> index 4d12084d9..08a6f1a50 100644
> --- a/lisp/org.el
> +++ b/lisp/org.el
> @@ -3600,13 +3600,13 @@ following symbols:
>              (const :tag "Entities" entities))))
>  
>  (defcustom org-hide-emphasis-markers nil
> -  "Non-nil mean font-lock should hide the emphasis marker characters."
> +  "Non-nil means font-lock should hide the emphasis marker characters."
>    :group 'org-appearance
>    :type 'boolean
>    :safe #'booleanp)
>  
>  (defcustom org-hide-macro-markers nil
> -  "Non-nil mean font-lock should hide the brackets marking macro calls."
> +  "Non-nil means font-lock should hide the brackets marking macro calls."
>    :group 'org-appearance
>    :type 'boolean)
>  
> @@ -3618,7 +3618,7 @@ When nil, the \\name form remains in the buffer."
>    :type 'boolean)
>  
>  (defcustom org-pretty-entities-include-sub-superscripts t
> -  "Non-nil means, pretty entity display includes formatting 
> sub/superscripts."
> +  "Non-nil means pretty entity display includes formatting sub/superscripts."
>    :group 'org-appearance
>    :version "24.1"
>    :type 'boolean)