git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 0/4] Use singular "they" when appropriate

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Jun 9, 2021, 17:22 UTC
Message-ID
<60c0f8c9d69c8_10749208d2@natae.notmuch>
In-Reply-To
<87a6nz2fda.fsf@evledraar.gmail.com>
Ævar Arnfjörð Bjarmason wrote:
Show 18 quoted lines
> 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.
Show 18 quoted lines
> --- 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.
Show 20 quoted lines
> --- 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?
Show 7 quoted lines
> ++
> +
> +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.
Show 15 quoted lines
>  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.
Show 15 quoted lines
>   * 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
Previous: Ævar Arnfjörð BjarmasonNext: Junio C Hamano
Message 76 of 124 in “Use singular "they" when appropriate”
  1. 0/4 Use singular "they" when appropriateDerrick Stolee via GitGitGadget, Jun 7, 2021
  2. 2/4 *: use singular they in commentsDerrick Stolee via GitGitGadget, Jun 7, 2021
  3. Ævar Arnfjörð BjarmasonJun 7, 2021
  4. Derrick StoleeJun 7, 2021
  5. Johannes SchindelinJun 10, 2021
  6. Junio C HamanoJun 7, 2021
  7. Felipe ContrerasJun 7, 2021
  8. Emily ShafferJun 8, 2021
  9. 1/4 Documentation: use singular they when appropriateDerrick Stolee via GitGitGadget, Jun 7, 2021
  10. Ævar Arnfjörð BjarmasonJun 7, 2021
  11. Derrick StoleeJun 7, 2021
  12. Andrei RybakJun 7, 2021
  13. Ævar Arnfjörð BjarmasonJun 7, 2021
  14. Johannes SchindelinJun 10, 2021
  15. Felipe ContrerasJun 10, 2021
  16. Felipe ContrerasJun 7, 2021
  17. Phillip SusiJun 9, 2021
  18. Felipe ContrerasJun 9, 2021
  19. Phillip SusiJun 11, 2021
  20. Felipe ContrerasJun 11, 2021
  21. Derrick StoleeJun 10, 2021
  22. Junio C HamanoJun 11, 2021
  23. Felipe ContrerasJun 11, 2021
  24. Phillip SusiJun 12, 2021
  25. Junio C HamanoJun 8, 2021
  26. Kerry, RichardJun 8, 2021
  27. Junio C HamanoJun 8, 2021
  28. Derrick StoleeJun 9, 2021
  29. Junio C HamanoJun 10, 2021
  30. Emily ShafferJun 8, 2021
  31. Felipe ContrerasJun 8, 2021
  32. Kerry, RichardJun 9, 2021
  33. Felipe ContrerasJun 9, 2021
  34. Kerry, RichardJun 25, 2021
  35. Junio C HamanoJun 9, 2021
  36. Johannes SchindelinJun 10, 2021
  37. Felipe ContrerasJun 10, 2021
  38. Robert KarszniewiczJun 14, 2021
  39. 4/4 CodingGuidelines: recommend singular theyDerrick Stolee via GitGitGadget, Jun 7, 2021
  40. Junio C HamanoJun 7, 2021
  41. Derrick StoleeJun 7, 2021
  42. Junio C HamanoJun 8, 2021
  43. brian m. carlsonJun 10, 2021
  44. Johannes SchindelinJun 10, 2021
  45. Ævar Arnfjörð BjarmasonJun 7, 2021
  46. Felipe ContrerasJun 8, 2021
  47. Felipe ContrerasJun 7, 2021
  48. Phillip SusiJun 9, 2021
  49. Felipe ContrerasJun 9, 2021
  50. Robert KarszniewiczJun 7, 2021
  51. Felipe ContrerasJun 7, 2021
  52. Jeff KingJun 8, 2021
  53. Felipe ContrerasJun 8, 2021
  54. Derrick StoleeJun 9, 2021
  55. Felipe ContrerasJun 9, 2021
  56. brian m. carlsonJun 10, 2021
  57. Felipe ContrerasJun 11, 2021
  58. Emily ShafferJun 8, 2021
  59. Junio C HamanoJun 9, 2021
  60. Derrick StoleeJun 9, 2021
  61. 3/4 *: fix typosDerrick Stolee via GitGitGadget, Jun 7, 2021
  62. Emily ShafferJun 8, 2021
  63. Johannes SchindelinJun 10, 2021
  64. Derrick StoleeJun 10, 2021
  65. Johannes SchindelinJun 11, 2021
  66. Felipe ContrerasJun 7, 2021
  67. 0/4 Use singular "they" when appropriateDerrick Stolee via GitGitGadget, Jun 9, 2021
  68. 4/4 CodingGuidelines: recommend singular theyDerrick Stolee via GitGitGadget, Jun 9, 2021
  69. Felipe ContrerasJun 9, 2021
  70. 3/4 *: fix typosDerrick Stolee via GitGitGadget, Jun 9, 2021
  71. 2/4 *: use singular they in commentsDerrick Stolee via GitGitGadget, Jun 9, 2021
  72. Felipe ContrerasJun 9, 2021
  73. 1/4 Documentation: use singular they when appropriateDerrick Stolee via GitGitGadget, Jun 9, 2021
  74. Felipe ContrerasJun 9, 2021
  75. Ævar Arnfjörð BjarmasonJun 9, 2021
  76. Felipe ContrerasJun 9, 2021
  77. Junio C HamanoJun 10, 2021
  78. Junio C HamanoJun 10, 2021
  79. Felipe ContrerasJun 10, 2021
  80. brian m. carlsonJun 10, 2021
  81. Ævar Arnfjörð BjarmasonJun 10, 2021
  82. Felipe ContrerasJun 11, 2021
  83. Derrick StoleeJun 11, 2021
  84. Felipe ContrerasJun 11, 2021
  85. Ævar Arnfjörð BjarmasonJun 13, 2021
  86. Junio C HamanoJun 15, 2021
  87. Derrick StoleeJun 15, 2021
  88. Felipe ContrerasJun 15, 2021
  89. Junio C HamanoJun 14, 2021
  90. 0/4 Avoid gendered pronounsDerrick Stolee via GitGitGadget, Jun 15, 2021
  91. 2/4 comments: avoid using the gender of our usersFelipe Contreras via GitGitGadget, Jun 15, 2021
  92. 1/4 doc: avoid using the gender of other peopleFelipe Contreras via GitGitGadget, Jun 15, 2021
  93. 3/4 *: fix typosDerrick Stolee via GitGitGadget, Jun 15, 2021
  94. 4/4 CodingGuidelines: recommend singular theyDerrick Stolee via GitGitGadget, Jun 15, 2021
  95. Ævar Arnfjörð BjarmasonJun 15, 2021
  96. Felipe ContrerasJun 15, 2021
  97. Junio C HamanoJun 16, 2021
  98. Junio C HamanoJun 16, 2021
  99. Bagas SanjayaJun 16, 2021
  100. Derrick StoleeJun 16, 2021
  101. Ævar Arnfjörð BjarmasonJun 16, 2021
  102. Felipe ContrerasJun 16, 2021
  103. Junio C HamanoJun 17, 2021
  104. Derrick StoleeJun 17, 2021
  105. Felipe ContrerasJun 17, 2021
  106. Ævar Arnfjörð BjarmasonJun 17, 2021
  107. Felipe ContrerasJun 17, 2021
  108. brian m. carlsonJun 18, 2021
  109. Felipe ContrerasJun 18, 2021
  110. Felipe ContrerasJun 17, 2021
  111. Ævar Arnfjörð BjarmasonJun 17, 2021
  112. brian m. carlsonJun 18, 2021
  113. Ævar Arnfjörð BjarmasonJun 18, 2021
  114. Felipe ContrerasJun 18, 2021
  115. Junio C HamanoJun 19, 2021
  116. Junio C HamanoJun 28, 2021
  117. Felipe ContrerasJun 29, 2021
  118. Derrick StoleeJun 29, 2021
  119. Ævar Arnfjörð BjarmasonJun 29, 2021
  120. Felipe ContrerasJun 17, 2021
  121. Felipe ContrerasJun 17, 2021
  122. Felipe ContrerasJun 15, 2021
  123. Bagas SanjayaJun 12, 2021
  124. Phillip SusiJun 12, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.