#1262 Golang: Miscellaneous improvements to the text of the naming guidelines
Merged by tibbs. Opened by rishi.
rishi/packaging-committee wip/rishi/golang-naming-gopkg-etc  into  master

Download 1262.patch

See the commits for details.

I am no expert in AsciiDoc, so I don't know if I got the formatting correct.

rebased onto fa0d16e3b3789ca2dd350893291485f80c485584

I am no expert in AsciiDoc, so I don't know if I got the formatting correct.

How to check the result is explained in the README:

Run the following commands and open http://localhost:8000/

$ make && make serve

Just looking at the diff, everything looks fine.

Also, the README asks to use semantic linebreaks, so perhaps you should use them?

Note: I am not a member of the Packaging Committee.
In the end, I will not be deciding if this pull request can be merged.
In particular, I have noticed that many changes that do not use semantic linebreaks are merged.

Thanks for the review, @oturpe

Also, the README asks to use semantic linebreaks, so perhaps you should use them?

Originally, I tried to wrap the lines at the 80-characters boundary. Now I added a semantic break after the full stop in the first patch. Is that OK?

rebased onto 778405f1d97b6274d7d8ff28e1441a13a8fd3527

Hmm, I don't see any difference.
Is this just Pagure giving me stale data?

Possibly.

Earlier it used to be:

- * Golang source packages MUST be named after their main import path.
+ * Golang source packages dedicated to providing code MUST be named after their
+   main import path. This

Now, it's:

- * Golang source packages MUST be named after their main import path.
+ * Golang source packages dedicated to providing code MUST be named after their
+   main import path.

Ok, I see. I was expecting this:

- * Golang source packages MUST be named after their main import path.
+ * Golang source packages dedicated to providing code MUST be named after their main import path.

I.e. there is no maximum length of a line, they just are as long as they need to be.
And if they get really too long, then it may be that shorter sentences should be used.

However, I am not sure if there is much to gain from iterating this,
seeing that the rest of the page already uses fixed line length style.

Thank you for contributring to the guidelines!

I.e. there is no maximum length of a line, they just are as
long as they need to be. And if they get really too long, then
it may be that shorter sentences should be used.

Aha, ok. I kept the 80-characters boundary because https://sembr.org/ recommended it. I don't have a strong opinion about it.

I have always interpreted that recommendation to mean "please write short sentences" :smile:

rebased onto 1016600e90e7815b7906fe24bbe130e62c05efd8

rebased onto 0437641412ac697bf25edb4fd3bb3356ede533e5

Pull-Request has been merged by tibbs

Thanks, @tibbs !

Metadata