Bug 252706 - Fix two minor typos i FreeBSD Handbook
Summary: Fix two minor typos i FreeBSD Handbook
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Guangyuan Yang
URL:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2021-01-15 12:09 UTC by Andreas Bjørnestad
Modified: 2021-04-27 00:46 UTC (History)
3 users (show)

See Also:

Attachments
commit to fix two minor typos (1.45 KB, patch)
2021-01-15 12:09 UTC, Andreas Bjørnestad 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Andreas Bjørnestad 2021-01-15 12:09:04 UTC 
Created attachment 221593 [details]
commit to fix two minor typos

Fix two minor typos in the FreeBSD Handbook.

See attached patch.
Comment 1 PauAmma freebsd_triage 2021-01-15 16:51:58 UTC 
Whether it's "a SCSI interface" or "an SCSI interface" depends on taste, namely whether SCSI is read as something like "scuzzy" or as spelled, as "ess see ess eye". I couldn't find any guidance about that in my quick perusal of https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style.html, but my instinct tells me that it would best be based on how screenreaders render "SCSI". Unfortunately, I have no idea what they do. Does anyone know?

I agree with the other change, though.
Comment 2 Ceri Davies 2021-01-15 19:09:45 UTC 
Comment on attachment 221593 [details]
commit to fix two minor typos

Second part of the patch isn't correct: "a SCSI CD" is fine as is.
Comment 3 Andreas Bjørnestad 2021-01-16 20:39:32 UTC 
Yes, I see your point. I pronounce it "ess see ess eye", hence the change.
Comment 4 Guangyuan Yang freebsd_committer 2021-01-17 17:51:51 UTC 
Thanks PauAmma and Ceri, I believe it makes sense to make the first change and leave "a SCSI" as is.
Comment 5 commit-hook freebsd_committer 2021-04-27 00:46:07 UTC 
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=1114f5f2d23fbc25373fe10de1a30680138042f3

commit 1114f5f2d23fbc25373fe10de1a30680138042f3
Author:     Andreas Bjørnestad <panden@gmail.com>
AuthorDate: 2021-04-27 00:42:09 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-04-27 00:42:55 +0000

    handbook: fix typo

    PR:     252706

 documentation/content/en/books/handbook/disks/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)