From: Felipe Contreras <felipe.contreras@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com,
sandals@crustytoothpaste.net, stolee@gmail.com,
jrnieder@gmail.com, emilyshaffer@google.com,
Andrei Rybak <rybak.a.v@gmail.com>,
Felipe Contreras <felipe.contreras@gmail.com>,
Robert Karszniewicz <avoidr@posteo.de>, Jeff King <peff@peff.net>,
"Kerry, Richard" <richard.kerry@atos.net>,
Derrick Stolee <derrickstolee@github.com>
Subject: Re: [PATCH v2 0/4] Use singular "they" when appropriate
Date: Wed, 09 Jun 2021 12:22:17 -0500 [thread overview]
Message-ID: <60c0f8c9d69c8_10749208d2@natae.notmuch> (raw)
In-Reply-To: <87a6nz2fda.fsf@evledraar.gmail.com>
Ævar Arnfjörð Bjarmason wrote:
> The below for-show patch[2] shows an alternate approach that I think is
> a better direction than this series.
>
> It shows how some of the s/he|she/they/g search-replacements you did
> could IMO be better if we simply reduced the amount of prose, e.g. in
> strbuf.h changing:
>
> passes a context pointer, which can be used by the programmer of the
> callback as she sees fit.
>
> To:
>
> passes a `void *context` to the callback `fn`
>
> Is a better change than a mere s/she/they/g. Nobody needs all this
> verbosity to understand the common pattern of passing a user-controlled
> 'void *` to a callback. It's implicitly understood by the technical
> level of the reader this documentation is targeted at.
!00% agreed.
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -551,6 +551,31 @@ Writing Documentation:
> documentation, please see the documentation-related advice in the
> Documentation/SubmittingPatches file).
>
> + Prefer succinctness and matter-of-factly describing functionality in
> + the abstract. E.g.:
> +
> + --short:: Emit output in the short-format.
> +
> + Not something like these overly verbose alternatives:
> +
> + --short:: Use this to emit output in the short-format.
> + --short:: You can use this to get output in the short-format.
> + --short:: A user who prefers shorter output could....
> + --short:: Should a person and/or program want shorter output, he
> + she/they/it can...
I'm a big fan of this succinct approach.
> --- a/Documentation/git-push.txt
> +++ b/Documentation/git-push.txt
> @@ -240,17 +240,17 @@ already exists on the remote side.
> This option overrides this restriction if the current value of the
> remote ref is the expected value. "git push" fails otherwise.
> +
> +When collaborating with others this is safer than using the `--force` option.
> Imagine that you have to rebase what you have already published.
> -You will have to bypass the "must fast-forward" rule in order to
> -replace the history you originally published with the rebased history.
> -If somebody else built on top of your original history while you are
> -rebasing, the tip of the branch at the remote may advance with her
> -commit, and blindly pushing with `--force` will lose her work.
> -+
> -This option allows you to say that you expect the history you are
> -updating is what you rebased and want to replace. If the remote ref
> -still points at the commit you specified, you can be sure that no
> -other people did anything to the ref. It is like taking a "lease" on
> +By using `--force` you might inadvertently clobber commits that
> +someone else pushed on top of branch.
* the branch?
> ++
> +
> +Unlike `--force`, `--force-with-lease` will transmit the expected
> +object ID to the remote server (similar to linkgit:git-update-ref[1]'s
> +`<oldvalue>`, and thus provides a safeguard against inadvertently
> +clobbering remote refs which have changed since you retrieved them
> +with `git fetch`. Using this option has the effect of taking a "lease" on
Clearer and more useful. I didn't even notice where the gender of the
reader was replaced, or where it supposedly came from.
Instead we focus on what's important: instructing the user.
> the ref without explicitly locking it, and the remote ref is updated
> only if the "lease" is still valid.
> +
> diff --git a/config.h b/config.h
> index 9038538ffd..a2200f3111 100644
> --- a/config.h
> +++ b/config.h
> @@ -450,8 +450,8 @@ void git_configset_init(struct config_set *cs);
> /**
> * Parses the file and adds the variable-value pairs to the `config_set`,
> * dies if there is an error in parsing the file. Returns 0 on success, or
> - * -1 if the file does not exist or is inaccessible. The user has to decide
> - * if he wants to free the incomplete configset or continue using it when
> + * -1 if the file does not exist or is inaccessible. The caller decides
> + * whether to free the incomplete configset or continue using it when
Gramatically correct and clear. This is a good change.
> * the function returns -1.
> */
> int git_configset_add_file(struct config_set *cs, const char *filename);
> diff --git a/strbuf.h b/strbuf.h
> index 223ee2094a..c7c67cfe14 100644
> --- a/strbuf.h
> +++ b/strbuf.h
> @@ -337,8 +337,8 @@ const char *strbuf_join_argv(struct strbuf *buf, int argc,
> * placeholder is unknown, then the percent sign is copied, too.
> *
> * In order to facilitate caching and to make it possible to give
> - * parameters to the callback, `strbuf_expand()` passes a context pointer,
> - * which can be used by the programmer of the callback as she sees fit.
> + * parameters to the callback, `strbuf_expand()` passes a
> + * `void *context` to the callback `fn`
Simple and to the point. +1
Cheers.
--
Felipe Contreras
next prev parent reply other threads:[~2021-06-09 17:22 UTC|newest]
Thread overview: 124+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-07 16:57 [PATCH 0/4] Use singular "they" when appropriate Derrick Stolee via GitGitGadget
2021-06-07 16:57 ` [PATCH 1/4] Documentation: use singular they " Derrick Stolee via GitGitGadget
2021-06-07 17:09 ` Ævar Arnfjörð Bjarmason
2021-06-07 17:32 ` Derrick Stolee
2021-06-07 17:42 ` Andrei Rybak
2021-06-07 18:21 ` Ævar Arnfjörð Bjarmason
2021-06-10 7:44 ` Johannes Schindelin
2021-06-10 14:35 ` Felipe Contreras
2021-06-07 21:36 ` Felipe Contreras
2021-06-09 18:47 ` Phillip Susi
2021-06-09 20:26 ` Felipe Contreras
2021-06-11 15:40 ` Phillip Susi
2021-06-11 17:03 ` Felipe Contreras
2021-06-10 18:30 ` Derrick Stolee
2021-06-11 0:16 ` Junio C Hamano
2021-06-11 16:00 ` Felipe Contreras
2021-06-12 14:02 ` Phillip Susi
2021-06-08 1:18 ` Junio C Hamano
2021-06-08 8:51 ` Kerry, Richard
2021-06-08 23:21 ` Junio C Hamano
2021-06-09 13:13 ` Derrick Stolee
2021-06-10 3:11 ` Junio C Hamano
2021-06-08 17:33 ` Emily Shaffer
2021-06-08 18:03 ` Felipe Contreras
2021-06-09 13:44 ` Kerry, Richard
2021-06-09 17:44 ` Felipe Contreras
2021-06-25 14:30 ` Kerry, Richard
2021-06-09 4:48 ` Junio C Hamano
2021-06-10 8:18 ` Johannes Schindelin
2021-06-10 14:42 ` Felipe Contreras
2021-06-14 22:10 ` Robert Karszniewicz
2021-06-07 16:57 ` [PATCH 2/4] *: use singular they in comments Derrick Stolee via GitGitGadget
2021-06-07 17:12 ` Ævar Arnfjörð Bjarmason
2021-06-07 17:20 ` Derrick Stolee
2021-06-10 8:20 ` Johannes Schindelin
2021-06-07 19:02 ` Junio C Hamano
2021-06-07 21:44 ` Felipe Contreras
2021-06-08 17:36 ` Emily Shaffer
2021-06-07 16:57 ` [PATCH 3/4] *: fix typos Derrick Stolee via GitGitGadget
2021-06-08 17:37 ` Emily Shaffer
2021-06-10 8:36 ` Johannes Schindelin
2021-06-10 19:53 ` Derrick Stolee
2021-06-11 9:55 ` Johannes Schindelin
2021-06-07 16:57 ` [PATCH 4/4] CodingGuidelines: recommend singular they Derrick Stolee via GitGitGadget
2021-06-07 18:31 ` Ævar Arnfjörð Bjarmason
2021-06-08 1:47 ` Felipe Contreras
2021-06-07 18:56 ` Junio C Hamano
2021-06-07 19:05 ` Derrick Stolee
2021-06-08 0:05 ` Junio C Hamano
2021-06-10 21:34 ` brian m. carlson
2021-06-10 8:39 ` Johannes Schindelin
2021-06-07 20:00 ` Felipe Contreras
2021-06-09 18:29 ` Phillip Susi
2021-06-09 20:18 ` Felipe Contreras
2021-06-07 20:20 ` Robert Karszniewicz
2021-06-07 22:18 ` Felipe Contreras
2021-06-08 7:10 ` Jeff King
2021-06-08 8:11 ` Felipe Contreras
2021-06-09 13:23 ` Derrick Stolee
2021-06-09 15:20 ` Felipe Contreras
2021-06-10 22:06 ` brian m. carlson
2021-06-11 16:11 ` Felipe Contreras
2021-06-08 17:39 ` Emily Shaffer
2021-06-09 4:44 ` Junio C Hamano
2021-06-09 13:27 ` Derrick Stolee
2021-06-07 20:10 ` [PATCH 0/4] Use singular "they" when appropriate Felipe Contreras
2021-06-09 13:54 ` [PATCH v2 " Derrick Stolee via GitGitGadget
2021-06-09 13:54 ` [PATCH v2 1/4] Documentation: use singular they " Derrick Stolee via GitGitGadget
2021-06-09 15:33 ` Felipe Contreras
2021-06-09 13:54 ` [PATCH v2 2/4] *: use singular they in comments Derrick Stolee via GitGitGadget
2021-06-09 15:41 ` Felipe Contreras
2021-06-09 13:54 ` [PATCH v2 3/4] *: fix typos Derrick Stolee via GitGitGadget
2021-06-09 13:54 ` [PATCH v2 4/4] CodingGuidelines: recommend singular they Derrick Stolee via GitGitGadget
2021-06-09 15:50 ` Felipe Contreras
2021-06-09 15:44 ` [PATCH v2 0/4] Use singular "they" when appropriate Ævar Arnfjörð Bjarmason
2021-06-09 17:22 ` Felipe Contreras [this message]
2021-06-10 2:03 ` Junio C Hamano
2021-06-10 2:28 ` Junio C Hamano
2021-06-10 3:30 ` Felipe Contreras
2021-06-10 22:32 ` brian m. carlson
2021-06-10 22:58 ` Ævar Arnfjörð Bjarmason
2021-06-11 16:32 ` Felipe Contreras
2021-06-11 17:18 ` Derrick Stolee
2021-06-11 20:38 ` Felipe Contreras
2021-06-13 7:17 ` Ævar Arnfjörð Bjarmason
2021-06-15 6:02 ` Junio C Hamano
2021-06-15 13:36 ` Derrick Stolee
2021-06-15 17:03 ` Felipe Contreras
2021-06-14 0:47 ` Junio C Hamano
2021-06-15 14:11 ` [PATCH v3 0/4] Avoid gendered pronouns Derrick Stolee via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 1/4] doc: avoid using the gender of other people Felipe Contreras via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 2/4] comments: avoid using the gender of our users Felipe Contreras via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 3/4] *: fix typos Derrick Stolee via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 4/4] CodingGuidelines: recommend singular they Derrick Stolee via GitGitGadget
2021-06-15 16:19 ` Ævar Arnfjörð Bjarmason
2021-06-15 17:26 ` Felipe Contreras
2021-06-16 2:47 ` Junio C Hamano
2021-06-16 5:06 ` Junio C Hamano
2021-06-16 9:26 ` Bagas Sanjaya
2021-06-16 17:44 ` Derrick Stolee
2021-06-16 19:54 ` Ævar Arnfjörð Bjarmason
2021-06-16 23:22 ` Felipe Contreras
2021-06-17 0:09 ` Junio C Hamano
2021-06-17 13:22 ` Derrick Stolee
2021-06-17 14:53 ` Ævar Arnfjörð Bjarmason
2021-06-17 17:06 ` Felipe Contreras
2021-06-17 15:25 ` Felipe Contreras
2021-06-18 0:26 ` brian m. carlson
2021-06-18 16:12 ` Felipe Contreras
2021-06-17 15:23 ` Felipe Contreras
2021-06-17 15:58 ` Ævar Arnfjörð Bjarmason
2021-06-18 0:53 ` brian m. carlson
2021-06-18 7:24 ` Ævar Arnfjörð Bjarmason
2021-06-18 16:40 ` Felipe Contreras
2021-06-19 7:03 ` Junio C Hamano
2021-06-28 22:32 ` Junio C Hamano
2021-06-29 1:31 ` Felipe Contreras
2021-06-29 1:53 ` Derrick Stolee
2021-06-29 12:29 ` Ævar Arnfjörð Bjarmason
2021-06-17 15:12 ` Felipe Contreras
2021-06-17 14:46 ` Felipe Contreras
2021-06-15 17:08 ` Felipe Contreras
2021-06-12 4:40 ` [PATCH 0/4] Use singular "they" when appropriate Bagas Sanjaya
2021-06-12 14:19 ` Phillip Susi
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: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=60c0f8c9d69c8_10749208d2@natae.notmuch \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=avoidr@posteo.de \
--cc=derrickstolee@github.com \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
--cc=richard.kerry@atos.net \
--cc=rybak.a.v@gmail.com \
--cc=sandals@crustytoothpaste.net \
--cc=stolee@gmail.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://80x24.org/mirrors/git.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).