unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Paul Eggert <eggert@cs.ucla.edu>
Cc: drew.adams@oracle.com, emacs-devel@gnu.org
Subject: RE: Scan of regexps in Emacs (March 17)
Date: Wed, 20 Mar 2019 21:21:38 -0700 (PDT)	[thread overview]
Message-ID: <36108066-ff96-48d2-86c0-06fb8ce127ba@default> (raw)
In-Reply-To: <<83d0mk6go5.fsf@gnu.org>>

> > As the Emacs documentation currently has thousands of occurrences of
> > "should", it sounds like we don't generally follow the guideline you're
> > suggesting.

If they're accompanied by stating _why_ you should
then there's generally no problem understanding.

Call that a scoped/qualified "should" - not really
a problem, because the follow-up explains (by
describing consequences) what we mean there by
"should".
 
> Indeed.  And the reason is likely that our documentation is not
> "technical documentation" in the sense meant in that article.

There was no article.  Just my opinion.  (The URL
was just to explain the term "weasel word".)

And in my opinion our doc _is_ technical doc.

If we don't say why you should then it's usually
preferable (IMO) to say that we "recommend" that
you do XYZ than to say you "should" do XYZ.

In any case, it's usually helpful to say why.

The problem with an empty "should" is that it's
vague, and it can be misunderstood as a (possibly
shame-faced) "must".  (Shame-faced ~ weasel.)

Something that's presented as an unexplained
recommendation is at least seldom confused with a
requirement (a "must").  "Should" is more vague
and is often understood as stronger than just
"it's a good idea" (a recommendation).

But "should", "recommend", and "must" all typically
beg the question of what happens if you don't.
With "should", in particular, it's also typically
unclear how important it is that you do what's
suggested.

"Must" is pretty clearly important - a requirement
of some sort.  But for "must" too it helps to say
what happens if you don't respect the rule.

To be clear, I'm not saying it's appropriate or
enough to just replace all occurrences of "should",
or that all such occurrences are unwise.



  parent reply	other threads:[~2019-03-21  4:21 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-17 13:50 Scan of regexps in Emacs (March 17) Mattias Engdegård
2019-03-19  1:21 ` Paul Eggert
2019-03-19 10:34   ` Mattias Engdegård
2019-03-20  1:53     ` Paul Eggert
2019-03-20  2:20       ` Stefan Monnier
2019-03-20 22:01         ` Paul Eggert
2019-03-20 22:59           ` Drew Adams
2019-03-20 23:10             ` Paul Eggert
2019-03-21  3:38               ` Eli Zaretskii
     [not found]             ` <<deeccd91-0f43-c329-6087-17435550b328@cs.ucla.edu>
     [not found]               ` <<83d0mk6go5.fsf@gnu.org>
2019-03-21  4:21                 ` Drew Adams [this message]
2019-03-21 14:17                   ` Eli Zaretskii
2019-03-21  0:57           ` Stefan Monnier
2019-03-21 11:15           ` Mattias Engdegård
2019-04-02  7:33             ` Paul Eggert
2019-04-02 14:15               ` Mattias Engdegård
2019-04-02 14:26                 ` Noam Postavsky
2019-04-02 19:13                   ` Mattias Engdegård
2019-04-02 16:58                 ` Stefan Monnier
2019-04-02 22:08                 ` Paul Eggert
2019-04-03  4:52                   ` Eli Zaretskii
2019-04-03 17:02                     ` Paul Eggert
2019-04-06  9:43                   ` Mattias Engdegård
2019-04-07  8:15                     ` Michael Albinus
2019-04-07  9:47                     ` Paul Eggert
2019-04-07 10:06                       ` Mattias Engdegård
2019-04-07 18:45                         ` Paul Eggert
2019-03-21  2:07         ` Richard Stallman
2019-03-22 13:26         ` Stephen Leake
2019-03-22 14:03           ` Stefan Monnier
2019-03-22 14:12           ` Mattias Engdegård
2019-03-20 10:04       ` Mattias Engdegård

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=36108066-ff96-48d2-86c0-06fb8ce127ba@default \
    --to=drew.adams@oracle.com \
    --cc=eggert@cs.ucla.edu \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    /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).