search

grid-x / modbus

BSD 3-Clause "New" or "Revised" License
78 stars 26 forks source link

Make go doc comments compliant with `gofmt` #72

Closed hnicolaysen closed 1 year ago

hnicolaysen commented 1 year ago

Make go doc comments compliant with gofmt by replacing double spaces with bullet points.

This is the result of a discussion here.

andig commented 1 year ago

@hsteidl please take a look at https://github.com/grid-x/modbus/pull/70/files#diff-f0426cbd040b8256849c69bbcc18df4b2364fa9cf487b21114fed91d784266feR87. I don't see any problem with applying gofmt without adding the kinda weird lists.

Update it seems the problem is here: https://github.com/grid-x/modbus/pull/70/files#diff-49830af181541bc76c8bca9e4401d808240a559716536397ae4d22947acddf32R78. The difference appears due to where the : is actually put.

Do we really need the lists or just use double columns consistently to become gofmt-friendly?

hnicolaysen commented 1 year ago

I'm fine with tabs at the beginning as well 👍 I updated the commit. I removed the weird blank lines that gofmt automatically inserts in front of the lists, gofmt doesn't complain about it when I manually remove them.

@andig I think I didn't get the "Update" part of your comment but I hope this solution fits for all of us.

Please have a look again!

andig commented 1 year ago

LGTM