Tom Slater's peer review: style and documentation

[amyheather]

Linting

• Is there a general preference for which to use? Nope!

• Typo...

Docstrings

• Any more advice on in-line commenting? Is it better to comment as much as possible? And how much becomes excessive? I often lean towards lots of comments, but this might not be the right approach! Either way I think some tips would be beneficial. Or maybe a longer function with more comments to show where it may or may not be appropriate. --> Have add some advice!

• Is it worth including a table on the different data types in R to help with writing docstrings? Or is this too basic? --> That's a good idea, have add a list.

• I think a template for writing a docstring would be useful. For example

  1. A sentence describing the purpose of the function.
  2. Write out every parameter, each on a new line. With structure @param name data_type description.
  3. Describe the output using structure @return data_type description.
  4. @export

GitHub Actions

• Typos...

Documentation

• Typo...

Badges examples are super helpful!