emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@gmail.com>
To: "Rudolf Adamkovič" <salutis@me.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Improve the docstring for 'org-html-mathjax-options'
Date: Sun, 28 Aug 2022 12:22:19 +0800	[thread overview]
Message-ID: <87h71xuhdw.fsf@localhost> (raw)
In-Reply-To: <m2czewdkhh.fsf@me.com>

> Subject: [PATCH] Fix incorrectly documented MathJax options

I am going through some old bug reports and there was another related
report about this docstring.

Rudolf, since you are probably more familiar with MathJax, may you
please take a look at the report below and tell us if the suggestions
are sensible?

https://orgmode.org/list/m2lf0j77jh.fsf@ego.team
Y. E. via "General discussions about Org-mode." <emacs-orgmode@gnu.org> (2021-12-17) (2021 emacs-orgmode.gnu.org inbox maillist)
Subject: [BUG] org-html-mathjax-options docstring [9.5.1 (release_9.5.1-11-g96d91b @ /emacs-28.0.90/lisp/org/)]

It seems the docstring of org-html-mathjax-options may need to be
updated.

I tried setting 'autonumber' to "None", as the docstring suggests, but
only the lower-cased "none" worked fine.

Also, MathJax documentation for 2.7 (the version I've got HTML rendered
with by org-mode) mentions "AMS", not "AMS Math"
(http://docs.mathjax.org/en/v2.7-latest/tex.html).

Another option that needs attention is 'indent'. The docstring contains
the phrase 'Valid values are "left" and "right"'. This phrase should be
changed to something like 'An example of a valid value is "2em"' or
simply removed, I think.


-- 
Ihor Radchenko,
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


  parent reply	other threads:[~2022-08-28  4:22 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-26  6:09 Improve the docstring for 'org-html-mathjax-options' Rudolf Adamkovič
2022-06-26  6:25 ` Ihor Radchenko
2022-06-26  6:26   ` Ihor Radchenko
2022-06-26  8:25   ` Bastien Guerry
2022-08-28  4:22 ` Ihor Radchenko [this message]
2022-08-31 14:18   ` Rudolf Adamkovič
2022-09-02 12:45     ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87h71xuhdw.fsf@localhost \
    --to=yantar92@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=salutis@me.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).