epiverse-trace / epiverse-trace.github.io

Technical blog of the Epiverse-TRACE project, where we share opinions and investigations in R package development, or scientific software development more generally
https://epiverse-trace.github.io/
3 stars 3 forks source link

Standardise imperative tense in hex wall package descriptions #268

Closed jamesmbaazam closed 3 weeks ago

jamesmbaazam commented 1 month ago

I just noticed that the package descriptions on the hex wall have a mix of tenses and could be standardized. The imperative tense would read more nicely, so I would suggest changing the descriptions of {readepi}, {cleanepi}, {epichains}, etc., to align with the others that already use that tense.

chartgerink commented 1 month ago

Thanks @jamesmbaazam for opening an issue - could you please add a example of the current language and the proposed one? This helps clarity on what you mean for those not as familiar with the grammar rules (my brain cannot parse grammar rules in any language for some reason 😅).

jamesmbaazam commented 1 month ago

Sure.

Two examples that currently align with my suggestion are:

others that can be aligned (not exhaustive):

package Current description Proposed change
readepi Tools for reading data Import data
cleanepi Tools for cleaning data Clean imported data
ColOpenData Open data for Colombia ¯_(ツ)_/¯
linelist Tagging and validating individual data Tag and validate individual data

I can submit a PR if that will make your life easier 😄 .

chartgerink commented 1 month ago

maybe there's a Chesterton fence

As an aside, I really like this. I'm adding it to my collection of mental models.

Bisaloo commented 1 month ago

No reason. The text here was written during the early quick prototyping phase and I have no objections for it to be updated.

jamesmbaazam commented 1 month ago

maybe there's a Chesterton fence

As an aside, I really like this. I'm adding it to my collection of mental models.

@chartgerink I'm so sorry I mistakenly deleted your original comment that I was quoting 😭 . If it's not too much trouble, could you repost it?