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

Re: [PATCH 0/6] doc: replace "alice" and "bob" examples

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Jun 16, 2021, 20:56 UTC
Message-ID
<60ca6586607f5_602720852@natae.notmuch>
In-Reply-To
<871r93ym8q.fsf@evledraar.gmail.com>
Ævar Arnfjörð Bjarmason wrote:
Show 29 quoted lines
> 
> On Tue, Jun 15 2021, Felipe Contreras wrote:
> 
> > Ævar Arnfjörð Bjarmason wrote:
> >> I suggested in [1] that the "alice" and "bob" examples in our
> >> documentation would be better written without a reference to such
> >> fictional characters, for reasons that have nothing to do with trying
> >> to bend over backwards to avoid any reference to people's gender. It
> >> just makes for better documentation.
> >
> > I'm fond of Alice and Bob, and I'm saddened they are the latest casualty
> > of the culture war, but if we are avoiding gender of examples, it makes
> > sense to let them go.
> >
> > However, I want to defend this usage a little.
> >
> >   1. Alice and Bob are familiar, so it requires less cogntive load from
> >      the user.
> >   2. Alice and Bob promote the usage of git as a distributed VCS, where
> >      unlike centralized VCS, you directly use the repositories of your
> >      colleagues.
> >   3. They provide some relief to an otherwise sterile landscape.
> >
> > I don't think these changes make for a necessarily better documentation,
> > just a more sterile one.
> 
> Fair enough, for what it's worth I wouldn't recommend against using
> these names in general, I would think you'd actively seek out those
> actors in e.g. cryptography documentation.

I have not read cryptography documentation, so for me Alice and Bob are simply two illustrative colleagues.

Show 5 quoted lines
> And as argued in 1/6 for those users who /are/ aware of "Alice and Bob"
> it's needless distraction. Maybe it's just me, but whenever I read
> references to them I keep waiting for the cryptography angle to be
> introduced. None of the uses in our documentation reflect that canonical
> usage.

It's probably not just you, but the vast majority of readers are likely not aware of any cryptographic reference.

> There's also just weird things in our documentation fixed by this
> series, such as referring to a random file tracked by git as "bob"
> instead of the more obvious "file.txt".
OK, _that_ I agree it's unequivocally an improvement.
Cheers.
-- 
Felipe Contreras
Previous: Ævar Arnfjörð BjarmasonNext: Phillip Susi
Message 17 of 24 in “doc: replace "alice" and "bob" examples”
  1. 0/6 doc: replace "alice" and "bob" examplesÆvar Arnfjörð Bjarmason, Jun 15, 2021
  2. 1/6 gittutorial doc: replace "alice" and "bob" with "you" and "www-data"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  3. Bagas SanjayaJun 16, 2021
  4. Junio C HamanoJun 16, 2021
  5. Felipe ContrerasJun 16, 2021
  6. Ævar Arnfjörð BjarmasonJun 17, 2021
  7. 2/6 gitcvs-migration doc: replace "alice" and "bob" with "you" and "www-data"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  8. Bagas SanjayaJun 16, 2021
  9. 3/6 daemon doc + code comments: reword "alice" exampleÆvar Arnfjörð Bjarmason, Jun 15, 2021
  10. 4/6 fast-import doc: change "bob" in an example to "file.txt"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  11. 5/6 doc: replace "alice" and "bob" with "jdoe" and "msmith"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  12. 6/6 pack-protocol doc: use "www-data" in place of "alice"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  13. Robert P. J. DayJun 15, 2021
  14. Ævar Arnfjörð BjarmasonJun 15, 2021
  15. Felipe ContrerasJun 15, 2021
  16. Ævar Arnfjörð BjarmasonJun 15, 2021
  17. Felipe ContrerasJun 16, 2021
  18. Phillip SusiJun 17, 2021
  19. Ævar Arnfjörð BjarmasonJun 17, 2021
  20. Junio C HamanoJun 16, 2021
  21. Robert P. J. DayJun 16, 2021
  22. Jeff KingJun 16, 2021
  23. Felipe ContrerasJun 16, 2021
  24. Randall S. BeckerJun 16, 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.