[PATCH] org-manual: Mark up nil as ~nil~ [9.6.6 (release_9.6.6 @ /home/blc/.local/share/emacs/30.0.50/lisp/org/)]

[PATCH] org-manual: Mark up nil as ~nil~ [9.6.6 (release_9.6.6 @ /home/blc/.local/share/emacs/30.0.50/lisp/org/)]

[Basil L. Contovounesios via General discussions about Org-mode.]

[-- Attachment #1: Type: text/plain, Size: 167 bytes --]

In emacs.git I noticed some occurrences of 'nil' in the generated
doc/misc/org.texi were not marked up as @code.

Is this TRT?  (I already have an Emacs CA on file.)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-org-manual.org-Mark-up-nil-as-nil.patch --]
[-- Type: text/x-diff, Size: 3621 bytes --]

From 69ee9636fb2cd52efe8c11ca5877c83fb984a9ea Mon Sep 17 00:00:00 2001
From: "Basil L. Contovounesios" <contovob@tcd.ie>
Date: Thu, 1 Jun 2023 22:19:28 +0100
Subject: [PATCH] doc/org-manual.org: Mark up nil as ~nil~

* doc/org-manual.org (Images, Plain lists in Texinfo export)
(Results of Evaluation): Mark up plain nil as ~nil~.
(Org Crypt): Ditto.  Clarify wording.
---
 doc/org-manual.org | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index ab5c10c1d..537cd046f 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11597,8 +11597,8 @@ command:
   =ORG-IMAGE-ACTUAL-WIDTH= property (subtree-level)[fn:: The width can
   be customized in Emacs >= 24.1, built with imagemagick support.].
   Their value can be the following:
-  - (default) Non-nil, use the actual width of images when inlining them.
-    If the actual width is too wide, limit it according to
+  - (default) Non-~nil~, use the actual width of images when inlining
+    them.  If the actual width is too wide, limit it according to
     ~org-image-max-width~.
   - When set to a number, use imagemagick (when available) to set the
     image's width to this value.
@@ -11608,7 +11608,7 @@ command:
     ,#+ATTR_HTML: :width 300px
     #+end_example
     and fall back on that number if none is found.
-  - When set to nil, try to get the width from an =#+ATTR.*= keyword
+  - When set to ~nil~, try to get the width from an =#+ATTR.*= keyword
     and fall back on the original width or ~org-image-max-width~ if
     none is found.
 
@@ -11618,8 +11618,8 @@ command:
   - (default) ~fill-column~, limit width to ~fill-column~ number of
     characters.
   - ~window~, limit width to current window width.
-  - integer number, limit width that specified number of pixels.
-  - nil, do not limit the width.
+  - integer number, limit width to that specified number of pixels.
+  - ~nil~, do not limit the width.
 
 #+vindex: org-cycle-inline-images-display
 Inline images can also be displayed when cycling the folding state.
@@ -15756,9 +15756,9 @@ This is the common text for variables foo and bar.
 
 The =:compact= attribute is an alternative to the =:sep= attribute,
 which allows writing each entry on its own line.  If this attribute is
-non-nil and an item in a description list has no body but is followed
-by another item, then the second item is transcoded to =@itemx=.  This
-example is transcoded to the same output as above.
+non-~nil~ and an item in a description list has no body but is
+followed by another item, then the second item is transcoded to
+=@itemx=.  This example is transcoded to the same output as above.
 
 #+begin_example
 ,#+ATTR_TEXINFO: :table-type vtable :indic asis :compact t
@@ -18666,7 +18666,7 @@ options; they are mutually exclusive.
   but no processing is performed on the return value.  Calling the
   code block programmatically (see [[*How to evaluate source code]]) or by
   reference (see [[*Passing arguments]] and [[*Noweb Reference Syntax]]) will
-  always yield nil.
+  always yield ~nil~.
 
 - =append= ::
 
@@ -20932,8 +20932,8 @@ specifying the respective key as property =CRYPTKEY=, e.g.:
   :END:
 #+end_example
 
-Note that =CRYPTKEY= property is only effective when ~org-crypt-key~
-is set to non-nil.  ~nil~ value of ~org-crypt-key~ makes Org use
+Note that the =CRYPTKEY= property is only effective when
+~org-crypt-key~ is non-~nil~.  If ~org-crypt-key~ is ~nil~, Org uses
 symmetric encryption unconditionally.
 
 Excluding the =crypt= tag from inheritance prevents already encrypted
-- 
2.34.1


[-- Attachment #3: Type: text/plain, Size: 5787 bytes --]


This is one of my first times posting here, and I am not subscribed to
the mailing list, so please keep me CCed and let me know if anything is
amiss.

Thanks,

-- 
Basil

Emacs  : GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo version 1.16.0, Xaw3d scroll bars)
 of 2023-05-30
Package: Org mode version 9.6.6 (release_9.6.6 @ /home/blc/.local/share/emacs/30.0.50/lisp/org/)

current state:
==============
(setq
 org-archive-location "/home/blc/.emacs.d/org/archive.org::"
 org-list-use-circular-motion t
 org-checkbox-hierarchical-statistics nil
 org-link-elisp-confirm-function 'yes-or-no-p
 org-hierarchical-todo-statistics nil
 org-agenda-category-icon-alist '(("" (space :width (16))))
 org-directory "/home/blc/.emacs.d/org/"
 org-global-properties '(("Effort_ALL" . "0 0:15 0:30 0:45 1:00 2:00 3:00"))
 org-agenda-scheduled-leaders '("" "%3dd -")
 org-log-done 'note
 org-log-into-drawer t
 org-agenda-timerange-leaders '("" "(%d/%d)")
 org-agenda-files "/home/blc/.emacs.d/org/agenda-index"
 org-persist-after-read-hook '(org-element--cache-persist-after-read)
 org-refile-targets '((org-agenda-files :maxlevel . 10))
 org-export-before-parsing-hook '(org-attach-expand-links)
 org-cycle-tab-first-hook '(org-babel-hide-result-toggle-maybe org-babel-header-arg-expand)
 org-default-notes-file "/home/blc/.emacs.d/org/notes.org"
 org-refile-use-outline-path 'file
 org-archive-hook '(org-attach-archive-delete-maybe)
 org-log-reschedule 'note
 org-columns-default-format "%ITEM %TODO %LOCATION %TAGS"
 org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-show-empty-lines
                  org-cycle-optimize-window-after-visibility-change org-cycle-display-inline-images)
 org-persist-before-read-hook '(org-element--cache-persist-before-read)
 org-agenda-sticky t
 org-modules nil
 org-mode-hook '(org-clock-load
                 #[0 "\300\301\302\303\304$\207" [add-hook change-major-mode-hook org-fold-show-all append local] 5]
                 #[0 "\300\301\302\303\304$\207"
                   [add-hook change-major-mode-hook org-babel-show-result-all append local] 5]
                 org-babel-result-hide-spec org-babel-hide-all-hashes
                 #[0 "\301\211%10\207" [imenu-create-index-function org-imenu-get-tree] 2] turn-on-auto-fill bog-mode
                 org-eldoc-load)
 org-babel-load-languages '((shell . t) (scheme . t) (python . t) (perl . t) (org . t) (ocaml . t) (makefile . t)
                            (lisp . t) (ledger . t) (latex . t) (js . t) (java . t) (haskell . t) (C . t)
                            (emacs-lisp . t))
 org-ctrl-k-protect-subtree t
 org-agenda-todo-list-sublevels nil
 org-agenda-time-grid '((daily today require-timed) (800 1000 1200 1400 1600 1800 2000) "......" "----------------")
 org-agenda-tags-column -80
 org-confirm-shell-link-function 'yes-or-no-p
 outline-isearch-open-invisible-function 'outline-isearch-open-invisible
 org-startup-indented t
 org-highlight-latex-and-related '(entities latex script)
 org-use-speed-commands t
 org-agenda-mode-hook '(hl-line-mode)
 org-list-demote-modify-bullet '(("+" . "-") ("-" . "+"))
 org-agenda-before-write-hook '(org-agenda-add-entry-text)
 org-log-redeadline 'note
 org-src-mode-hook '(org-src-babel-configure-edit-buffer org-src-mode-configure-edit-buffer)
 org-confirm-elisp-link-function 'yes-or-no-p
 org-agenda-todo-ignore-with-date t
 org-agenda-window-setup 'other-frame
 org-clock-idle-time 10
 org-todo-keywords '((type "NEXT(n)" "TODO(t)" "PROJ(p)" "EXEC(e)" "MEET(m)" "WAIT(w)" "BALK(b)" "|" "DONE(d!)"
                      "VOID(v@)")
                     )
 org-speed-command-hook '(org-speed-command-activate org-babel-speed-command-activate)
 org-clock-persist-file "/home/blc/.emacs.d/index/org-clock-save.el"
 org-fold-core-isearch-open-function 'org-fold-core--isearch-reveal
 org-capture-before-finalize-hook '(blc-org-prop-captured)
 org-M-RET-may-split-line nil
 org-clock-persist 'history
 org-persist-before-write-hook '(org-element--cache-persist-before-write)
 org-tab-first-hook '(org-babel-hide-result-toggle-maybe org-babel-header-arg-expand)
 org-link-shell-confirm-function 'yes-or-no-p
 org-babel-pre-tangle-hook '(save-buffer)
 org-agenda-loop-over-headlines-in-active-region nil
 outline-minor-mode-cycle t
 org-occur-hook '(org-first-headline-recenter)
 org-metadown-hook '(org-babel-pop-to-session-maybe)
 org-treat-S-cursor-todo-selection-as-state-change nil
 org-link-parameters '(("attachment" :follow org-attach-follow :complete org-attach-complete-link)
                       ("id" :follow org-id-open) ("file+sys") ("file+emacs") ("shell" :follow org-link--open-shell)
                       (#1="news" :follow
                        #[514 #2="\301\300\302%4Q%2\"\207" [#1# browse-url #4=":"] 6 #5="\n\n(fn URL ARG)"])
                       (#3="mailto" :follow #[514 #2# [#3# browse-url #4#] 6 #5#])
                       (#6="https" :follow #[514 #2# [#6# browse-url #4#] 6 #5#])
                       (#7="http" :follow #[514 #2# [#7# browse-url #4#] 6 #5#])
                       (#8="ftp" :follow #[514 #2# [#8# browse-url #4#] 6 #5#])
                       ("help" :follow org-link--open-help :store org-link--store-help)
                       ("file" :complete org-link-complete-file) ("elisp" :follow org-link--open-elisp))
 org-metaup-hook '(org-babel-load-in-session-maybe)
 org-refile-allow-creating-parent-nodes 'confirm
 org-property-format "%-20s %s"
 org-outline-path-complete-in-steps nil
 org-special-ctrl-a/e t
 org-reverse-note-order t
 org-agenda-current-time-string "now - - - - - - - - - - - - - - - - - - - - - - - - -"
 org-agenda-block-separator 61
 org-footnote-section nil
 org-list-allow-alphabetical t
 org-agenda-deadline-leaders '("" "%3dd +" "%3dd -")
 )

Re: [PATCH] org-manual: Mark up nil as ~nil~ [9.6.6 (release_9.6.6 @ /home/blc/.local/share/emacs/30.0.50/lisp/org/)]

[Ihor Radchenko]

Basil L. Contovounesios via "General discussions about Org-mode."
<emacs-orgmode@gnu.org> writes:

> In emacs.git I noticed some occurrences of 'nil' in the generated
> doc/misc/org.texi were not marked up as @code.
>
> Is this TRT?  (I already have an Emacs CA on file.)

Thanks!
Applied, onto main.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=a00889997

I also marked your copyright status a complete in our records, confirmed
by Emacs commits.
https://git.sr.ht/~bzg/worg/commit/dcd6afb9

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>