unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Paul Eggert <eggert@cs.ucla.edu>
To: Stefan Monnier <monnier@IRO.UMontreal.CA>
Cc: emacs-devel@gnu.org
Subject: Re: [Emacs-diffs] master 9ffb6ce 5/5: Quoting fixes in lisp/international and lisp/leim
Date: Tue, 1 Sep 2015 12:25:28 -0700	[thread overview]
Message-ID: <55E5FBA8.3090807@cs.ucla.edu> (raw)
In-Reply-To: <jwvzj16qi3a.fsf-monnier+emacs@gnu.org>

On 09/01/2015 08:39 AM, Stefan Monnier wrote:
> - The `...' markup (and it is markup) is ambiguous.
It certainly is (and always has been, alas), but before jumping into 
improving it, could you explain what ambiguities you'd like to resolve 
with an improved markup?

Currently `...' markup in docstrings is used for:

   * Symbols, e.g., `load-file'

   * Info nodes, e.g., `(emacs)Lisp Libraries'.

   * URLs, e.g., `http://bama.ua.edu/cgi-bin/man-cgi?lp'

   * Characters, e.g., `&', ` '.

   * Key sequences, e.g., `C-x ESC O P'.

   * Strings, e.g., `69'.

   * Regular expressions, e.g., `\\(_P\\|_PROTO\\)'.

   * English phrases, e.g., `close in spirit', `things'.

   * Lisp patterns, e.g., `(ATOM . ELLIPSIS)'.

   * Lisp code, e.g., `(thai nil nil (mark))'.

   * Non-Lisp code, e.g., `ls -lR'.

   * Probably some other stuff I’ve missed.

Most of these items are sometimes put in block quotations rather than in 
quote symbols, if they are long enough.

So, when removing ambiguity, how many categories would you like to put 
the above examples in?  And how should the different categories be 
rendered on plain-text consoles and on graphical displays?  I sort of 
have the impression that by “markup” you mean “things that should turn 
into links”, but maybe you mean “things that should be rendered in 
fixed-width font if we have a nice display”, or maybe there are two or 
even more kinds of markup that you have in mind.



  parent reply	other threads:[~2015-09-01 19:25 UTC|newest]

Thread overview: 80+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20150831061236.27796.57762@vcs.savannah.gnu.org>
     [not found] ` <E1ZWIKb-0007FR-Kk@vcs.savannah.gnu.org>
2015-08-31  6:26   ` [Emacs-diffs] master b533552 2/5: Documentation fixes re quotes Dmitry Gutov
2015-08-31  6:39     ` Paul Eggert
2015-08-31  6:47       ` Dmitry Gutov
2015-08-31  6:53         ` Paul Eggert
2015-08-31  7:00           ` Dmitry Gutov
2015-08-31  7:13             ` Paul Eggert
2015-09-01  0:03           ` Richard Stallman
2015-09-02  1:05             ` Paul Eggert
2015-09-02  1:27               ` David Kastrup
2015-09-02  1:30                 ` Paul Eggert
2015-09-02  5:19                   ` David Kastrup
2015-09-02  5:30                     ` Paul Eggert
2015-09-02 15:40                     ` Richard Stallman
2015-09-02 16:32                       ` David Kastrup
2015-09-03 15:38               ` Dmitry Gutov
2015-09-03 17:42                 ` Paul Eggert
2015-09-03 18:49                   ` Dmitry Gutov
2015-09-03 21:50                     ` Paul Eggert
2015-09-03 22:08                       ` Dmitry Gutov
2015-09-03 22:47                         ` Paul Eggert
2015-09-03 22:59                           ` Dmitry Gutov
2015-09-07  1:28               ` Richard Stallman
     [not found] ` <E1ZWIKd-0007Fs-15@vcs.savannah.gnu.org>
2015-08-31  6:29   ` [Emacs-diffs] master 9ffb6ce 5/5: Quoting fixes in lisp/international and lisp/leim Dmitry Gutov
2015-08-31  6:38     ` Paul Eggert
2015-08-31 17:34     ` Stefan Monnier
2015-08-31 18:40       ` Dmitry Gutov
2015-08-31 18:48       ` Paul Eggert
2015-09-01  7:35         ` David Kastrup
2015-08-31 17:40     ` Stefan Monnier
2015-08-31 18:03       ` Paul Eggert
2015-09-01  1:55         ` Stephen J. Turnbull
2015-09-01  3:40         ` Stefan Monnier
2015-09-01  6:29           ` Paul Eggert
2015-09-01 10:45           ` Oleh Krehel
2015-09-01 10:53             ` Andreas Schwab
2015-09-01 11:22             ` David Kastrup
2015-09-01 11:40               ` Oleh Krehel
2015-09-01 11:42               ` Dmitry Gutov
2015-09-01 12:06                 ` David Kastrup
2015-09-01 14:20                   ` Dmitry Gutov
2015-09-03 10:16                     ` Oleh Krehel
2015-09-03 11:22                       ` Dmitry Gutov
2015-09-03 14:50                         ` Stefan Monnier
2015-09-03 15:04                           ` Dmitry Gutov
2015-09-01 13:31               ` Paul Eggert
2015-09-01 14:15                 ` David Kastrup
2015-09-01 15:39             ` Stefan Monnier
2015-09-01 19:00               ` Alan Mackenzie
2015-09-02  4:07                 ` Stefan Monnier
2015-09-02  5:28                   ` David Kastrup
2015-09-02 10:02                   ` Alan Mackenzie
2015-09-02 11:22                     ` Dmitry Gutov
2015-09-02 15:41                       ` Richard Stallman
2015-09-02 15:53                         ` Dmitry Gutov
2015-09-02 16:38                         ` Paul Eggert
2015-09-03 15:37                           ` Richard Stallman
2015-09-03 17:26                             ` Paul Eggert
2015-09-02 16:32                     ` Paul Eggert
2015-09-02 17:23                       ` Alan Mackenzie
2015-09-02 17:43                         ` David Kastrup
2015-09-02 22:25                           ` Paul Eggert
2015-09-03 10:48                             ` David Kastrup
2015-09-03 12:45                               ` Andreas Schwab
2015-09-03 14:46                               ` Eli Zaretskii
2015-09-02 22:13                         ` Paul Eggert
2015-09-03 12:22                           ` Alan Mackenzie
2015-09-03 14:56                             ` Paul Eggert
2015-09-04 13:22                               ` Alan Mackenzie
2015-09-02 20:14                     ` Stefan Monnier
2015-09-01 19:25               ` Paul Eggert [this message]
2015-09-07  1:28                 ` Richard Stallman
2015-09-01 19:33               ` Dmitry Gutov
2015-09-02  2:34                 ` Stefan Monnier
2015-09-02  5:23                   ` David Kastrup
2015-09-02 11:16                   ` Dmitry Gutov
2015-09-02 11:52                     ` Quoting yank/diff prefixes (was: [Emacs-diffs] master 9ffb6ce 5/5: Quoting fixes in lisp/international and lisp/leim) David Kastrup
2015-09-03 14:34                     ` [Emacs-diffs] master 9ffb6ce 5/5: Quoting fixes in lisp/international and lisp/leim Stefan Monnier
2015-09-01 22:57             ` Richard Stallman
2015-09-01  0:03     ` Richard Stallman
2015-09-01  1:20       ` Paul Eggert

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.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=55E5FBA8.3090807@cs.ucla.edu \
    --to=eggert@cs.ucla.edu \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@IRO.UMontreal.CA \
    /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.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).