Date: Thu, 07 Sep 2023 17:18:24 +0000 From: bugzilla-noreply@freebsd.org To: doc@FreeBSD.org Subject: [Bug 273619] Committer's guide: potential for confusion with the currently given paths Message-ID: <bug-273619-9@https.bugs.freebsd.org/bugzilla/>
next in thread | raw e-mail | index | archive | help
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D273619 Bug ID: 273619 Summary: Committer's guide: potential for confusion with the currently given paths Product: Documentation Version: Latest Hardware: Any URL: https://github.com/freebsd/freebsd-doc/blob/main/docum entation/content/en/articles/committers-guide/_index.a doc#71-for-new-committers OS: Any Status: New Keywords: needs-patch Severity: Affects Some People Priority: --- Component: Books & Articles Assignee: doc@FreeBSD.org Reporter: grahamperrin@gmail.com In <https://docs.freebsd.org/en/articles/committers-guide/#conventions>; ste= p 1, it's not immediately clear that doc/ means the doc tree.=20 >From step 5 and then step 9 it might be inferred that the first word in a p= ath represents a tree, however (to the best of my recollection) this approach is not commonplace.=20 In any case: inference is not ideal. Instead, be clear.=20 <https://docs.freebsd.org/en/books/fdp-primer/book/#writing-style-be-clear>; --=20 You are receiving this mail because: You are the assignee for the bug.=
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?bug-273619-9>