carpentries-incubator / fair-research-software

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software
https://carpentries-incubator.github.io/fair-research-software/
Other
7 stars 4 forks source link

Possible inconsistency in the discussion of the accessibility principle between Introduction and Tools Episodes #82

Closed kkh451 closed 1 week ago

kkh451 commented 1 week ago

In the tools episode we say:

Accessible:
...

- Use coding conventions and comments to make your code readable and understandable by people (once they get a copy of it)"

But in the fair research software episode, in the tools table Accessible is not checked for testing and documentation. Is accessibility ONLY about "getting" the code or data or does it extend to readability and understandability; if yes, then Accessibility should be checked for both testing and documentation as well as reusability?

anenadic commented 1 week ago

I'd say accessibility is also about understanding the code (so coding conventions, comments, etc. would fall under this) - I think that was a mistake in the table for "Coding conventions and documentation" where findability is checked but probably accessibility was meant. Will fix.

Not sure about testing though - that's a strange one - making sure the code is correct - does that help with accessibility or understandability? Not sure but am OK to tick the accessibility box too @kkh451.

anenadic commented 1 week ago

Fixed via 5f87cbf