Bug 252493 - Stop using "Because" in sentence fragments
Summary: Stop using "Because" in sentence fragments
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Daniel Ebdrup Jensen
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-01-07 16:15 UTC by Ceri Davies
Modified: 2021-01-08 15:32 UTC (History)
2 users (show)

See Also:


Attachments
Patch (11.24 KB, patch)
2021-01-07 16:15 UTC, Ceri Davies
no flags Details | Diff
Corrected patch (20.63 KB, patch)
2021-01-07 17:53 UTC, Ceri Davies
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ceri Davies 2021-01-07 16:15:19 UTC
Created attachment 221354 [details]
Patch

Sentences beginning with "because" are usually sentence fragments; reword where that is the case.

Patch covers articles/ - if it's welcome then I am also happy to do books/
Comment 1 Mateusz Piotrowski freebsd_committer 2021-01-07 16:28:10 UTC
Comment on attachment 221354 [details]
Patch

Thanks for the patch. I just have on question:

>diff --git a/en_US.ISO8859-1/articles/linux-emulation/article.xml b/en_US.ISO8859-1/articles/linux-emulation/article.xml
>index d3e6c8742e..6e94e16e1a 100644
>--- a/en_US.ISO8859-1/articles/linux-emulation/article.xml
>+++ b/en_US.ISO8859-1/articles/linux-emulation/article.xml
>@@ -403,9 +403,7 @@
> 	    different API(es).  The M:N library uses the
> 	    <literal>kse_*</literal> family of syscalls while the 1:1
> 	    library uses the <literal>thr_*</literal> family of
>-	    syscalls.  Because of this, there is no general concept of
>-	    thread ID shared between kernel and userspace.  Of course,
>-	    both threading libraries implement the pthread thread ID
>+	    syscalls.  Due to this, libraries implement the pthread thread ID
> 	    API.  Every kernel thread (as described by <literal>struct
> 	      thread</literal>) has td tid identifier but this is not
> 	    directly accessible from userland and solely serves the

This chunk changes much more than wording. I am not sure if that was your intention. Perhaps we could split the content and wording change into two commits in case that's on purpose.
Comment 2 Ceri Davies 2021-01-07 17:15:14 UTC
Oh, that's a mistake.  Sorry!
Comment 3 Ceri Davies 2021-01-07 17:53:51 UTC
Created attachment 221358 [details]
Corrected patch

New patch attached.
Comment 4 Mateusz Piotrowski freebsd_committer 2021-01-07 20:30:38 UTC
Thanks.

I'll take a closer look now
Comment 5 PauAmma freebsd_triage 2021-01-07 21:43:40 UTC
Not a native speaker, but I haven't seen any actual sentence fragments in the current text. That said, the change reads less repetitive to me and doesn't change the meaning that I could see.
Comment 6 Mateusz Piotrowski freebsd_committer 2021-01-08 13:06:53 UTC
Assign to debdrup.
Comment 7 commit-hook freebsd_committer 2021-01-08 13:24:06 UTC
A commit in branch main references this bug:

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

commit e194334c7994de1d5aa91259075cc4e05d0b4a73
Author:     Daniel Ebdrup Jensen <debdrup@FreeBSD.org>
AuthorDate: 2021-01-08 13:04:42 +0000
Commit:     Daniel Ebdrup Jensen <debdrup@FreeBSD.org>
CommitDate: 2021-01-08 13:04:42 +0000

    Arch handbook and articles: Reword sentences beginning with 'Because...'

    These sentences can either be or be mistaken for being sentence
    fragments. While it is perfectly reasonable to use subordinate
    conjunctions conversationally, as long as both clauses are explicitly
    used in the same sentence, the handbook or articles are not written
    in this style.

    PR:             252493
    Submitted by:   Ceri Davies (ceri AT submonkey.net)
    Reviewed by:    0mp, pauamma (pauamma AT gundo.com)

 en_US.ISO8859-1/articles/committers-guide/article.xml    |  2 +-
 .../articles/contributors/contrib.develinmemoriam.xml    |  2 +-
 en_US.ISO8859-1/articles/ldap-auth/article.xml           |  2 +-
 en_US.ISO8859-1/articles/linux-emulation/article.xml     |  8 ++++----
 en_US.ISO8859-1/articles/serial-uart/article.xml         | 16 ++++++++--------
 en_US.ISO8859-1/articles/solid-state/article.xml         | 10 +++++-----
 en_US.ISO8859-1/articles/vm-design/article.xml           |  2 +-
 en_US.ISO8859-1/books/arch-handbook/boot/chapter.xml     |  8 ++++----
 .../books/arch-handbook/driverbasics/chapter.xml         |  4 ++--
 en_US.ISO8859-1/books/arch-handbook/isa/chapter.xml      | 10 +++++-----
 en_US.ISO8859-1/books/arch-handbook/pccard/chapter.xml   |  2 +-
 en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml     |  8 ++++----
 en_US.ISO8859-1/books/arch-handbook/usb/chapter.xml      |  2 +-
 13 files changed, 38 insertions(+), 38 deletions(-)
Comment 8 Mateusz Piotrowski freebsd_committer 2021-01-08 13:58:05 UTC
(In reply to Ceri Davies from comment #0)
Thanks for the patch! We would love to review and commit another set of similar changes for books/ :)
Comment 9 Ceri Davies 2021-01-08 15:32:03 UTC
(In reply to Mateusz Piotrowski from comment #8)
ok, you're on - 252519