nextstrain / seasonal-cov

Nextstrain build for seasonal coronaviruses
https://nextstrain.org/seasonal-cov/
1 stars 0 forks source link

Cleanup 6 #7

Closed genehack closed 4 months ago

genehack commented 5 months ago

Description of proposed changes

Various cleanup as detailed in #6

tsibley commented 5 months ago

Wrap lines for consistent length [#6]

I'm +1 for this, but will note that generally there's two styles we use for prose:

  1. One sentence per line
  2. Hard-wrapped lines (e.g. often around 80 chars)

(1) is preferred by some when lots of revising will take place (e.g. in manuscripts) as it can help make the diffs easier to read.

(2) is preferred by some (at least by me) when writing files which are primarily expected to be read in source form (e.g. source code comments or technical documentation referred to alongside the code), even if it is/could be rendered in some contexts (e.g. a Markdown README).

When to use one vs. the other is mostly a matter of taste, but we try to keep it consistent within a single file.

genehack commented 5 months ago

When to use one vs. the other is mostly a matter of taste, but we try to keep it consistent within a single file.

Thanks for the context -- I'm firmly in camp 2 but acknowledge the utility of camp 1 / soft-wrapping for things like manuscripts.

genehack commented 4 months ago

Just a heads up, gonna merge this at some point today, before starting on the CI work.