Bug 930668 – sys-apps/sandbox: Improve README.md readability and provide guidance on documentation

• Status: UNCONFIRMED
• Product: Portage Development

[Description Gil Kloepfer 2024-04-25 14:16:33 UTC]

While browsing README.md for sys-apps/sandbox, some of the text was a bit awkward to read.  I (hopefully) improved this (see patch as part of this report).  I also added a section on Documentation to the README.md that will hopefully help address bug #462352 (or at least point interested parties in the correct direction).

Reproducible: Always

[Comment 1 Gil Kloepfer 2024-04-25 14:17:08 UTC]

Created attachment 891691 [details, diff]
Patch to README.md with improved text

[Comment 2 Gil Kloepfer 2024-04-25 14:20:37 UTC]

Created attachment 891692 [details, diff]
FIXED patch to README.md with improved text

After submitting the original patch, I found a grammatical error that I introduced.  This patch should be the final one.

[Comment 3 Mike Gilbert 2024-04-25 15:20:16 UTC]

Thanks for the input.

If possible, please open a PR on github[1], or attach a patch generated using "git format-patch". This will allow us to attribute authorship correctly.

[1] https://github.com/gentoo/sandbox

[Comment 4 Gil Kloepfer 2024-04-26 01:12:32 UTC]

Created attachment 891757 [details, diff]
Patch in git format-patch email format

This is the above patch in git format-patch format.

[Comment 5 Gil Kloepfer 2024-04-26 01:15:57 UTC]

(In reply to Mike Gilbert from comment #3)
> If possible, please open a PR on github[1], or attach a patch generated
> using "git format-patch". This will allow us to attribute authorship
> correctly.
> [1] https://github.com/gentoo/sandbox

Thanks, Mike.  I'm a bit of a newbie when it comes to using git (Github specifically).  So I generated the git format-patch output and attached it to this report.  It should merge fine, but I'm unfortunately not too comfortable with the pull request mechanism yet.  Hope this helps.