emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Matt <matt@excalamus.com>
To: "Ihor Radchenko" <yantar92@posteo.net>
Cc: "emacs-orgmode" <emacs-orgmode@gnu.org>
Subject: Re: [PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is human-readable
Date: Sat, 06 Jan 2024 11:31:21 +0100	[thread overview]
Message-ID: <18cde53c69e.d9f0bdc2329217.4810513501666129976@excalamus.com> (raw)
In-Reply-To: <8734vc6iam.fsf@localhost>


 ---- On Fri, 05 Jan 2024 14:04:17 +0100  Ihor Radchenko  wrote --- 

 > Thanks for the comments!
 > I am attaching the next iteration of the patch.

Looks good

 > Matt matt@excalamus.com> writes:
 > 
 > > +Org Mode is an authoring tool and a to-do lists manager for GNU Emacs.
 > > +It uses a legible plain-text notation to show formatting, structure,
 > > +relationships.  Anyone able to edit text can write using Org.  Anyone
 > > +able to read text can view it.
 > 
 > As a non-native speaker, I have some difficulties understanding
 > "legible" meaning in this context. 

How does it come across to you?

 > Also, "anyone able to read text can
 > view it" would be a bit of a bold claim, I think. So, I went with more
 > moderate wording.
 
Good call.  That whole sentence is a mess.  When I wrote "anyone able to read text", I intended to say something like "if a computer can render the text".  However, that reduces to "if a computer can render it, then you can view it" which isn't very impressive.

When you say Org markup is "human-readable", I see that coming from it being plain-text.  It requires no special tools.  It's readable like "accessible, easily obtained".  I'm contrasting that with Jupyter Notebooks.  I think this aspect of readability is something we should emphasize.

Readability also means that what's written can be inferred without referencing other sources.  It's readable like "apparent, easily understood".  I think this is probably what you're thinking of.

What do you mean by "human-readable"?

--
Matt Trzcinski
Emacs Org contributor (ob-shell)
Learn more about Org mode at https://orgmode.org
Support Org development at https://liberapay.com/org-mode



  reply	other threads:[~2024-01-06 10:32 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-31 15:24 [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable Ihor Radchenko
2024-01-02  5:24 ` Thomas S. Dye
2024-01-03  7:52   ` Jean Louis
2024-01-03 12:36     ` Bastien Guerry
2024-01-03 13:00     ` Ihor Radchenko
2024-01-02 22:47 ` Matt
2024-01-03 13:44   ` Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable) Ihor Radchenko
2024-01-03 20:43     ` Matt
2024-01-05 13:17       ` Ihor Radchenko
2024-01-05 13:06 ` [PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is human-readable Ihor Radchenko
2024-01-06 10:31   ` Matt [this message]
2024-01-06 12:55     ` Ihor Radchenko
2024-01-06 12:56       ` Matt
2024-02-01 12:16   ` 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=18cde53c69e.d9f0bdc2329217.4810513501666129976@excalamus.com \
    --to=matt@excalamus.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@posteo.net \
    /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).