emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Possible small formatting change in manual (section 15.1)
@ 2021-04-13 22:59 Ian Nehera
  0 siblings, 0 replies; 2+ messages in thread
From: Ian Nehera @ 2021-04-13 22:59 UTC (permalink / raw)
  To: emacs-orgmode

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

Hi, I was reading the org manual section on source code blocks and I
think there’s a small section where the clarity can be improved.

Section 15.1: Features Overview, first paragraph (line 16396 of org.org)
	original: …Users can control how live they want each source code block…
	proposed change 1: …control how [“live”] they want…
	proposed change 2: …control [the “liveliness” of] each source…

When the paragraph first introduces the term “live code block”, it’s italicized. I think
it should stay italicized for the rest of that paragraph since it’s the introduction of the
term (I had to re-read the sentence a few times myself before it fully made sense).

Just a small suggestion; it wasn’t detrimental to my understanding or anything but
more of a small hiccup.
Best,
Ian

[-- Attachment #2: Type: text/html, Size: 2137 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Possible small formatting change in manual (section 15.1)
@ 2021-04-15  7:59 autofrettage
  0 siblings, 0 replies; 2+ messages in thread
From: autofrettage @ 2021-04-15  7:59 UTC (permalink / raw)
  To: emacs-orgmode@gnu.org

Ian wrote:
> When the paragraph first introduces the term “live code
> block”, it’s italicized. I think it should stay italicized
> for the rest of that paragraph since it’s the introduction
> of the term

I am not one of the authors of the manual, but my impression, after spending most of my life reading manuals, scientific reports, and a lot of other terminology-rich literature, is that new terms are typographically emphasised once and once only.

Cheers
Rasmus



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-04-15  8:01 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-04-15  7:59 Possible small formatting change in manual (section 15.1) autofrettage
  -- strict thread matches above, loose matches on Subject: below --
2021-04-13 22:59 Ian Nehera

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).