indigo-dc / sqa-baseline

A set of Common Software Quality Assurance Baseline Criteria for Research Projects
Other
11 stars 3 forks source link

[TYPO] Usage of "peer" in the description of 4.13 (QC.Rev) #73

Closed gmolto closed 2 years ago

gmolto commented 2 years ago

Describe and locate the typo The sentence "Code review implies the informal, non-automated, peer, human-based revision of any change in the source code" uses the word "peer" as an adjective but it is noun (and can also be used as a verb). Also, it explicitly includes an unnecessary reference to a "human" if the term "peer review" is used instead.

Expected content I'd suggest rephrasing as follows: "Code review implies the informal, non-automated, peer review of any change in the source code

Additional context Peer review is the evaluation of work by one or more people with similar competences: https://en.wikipedia.org/wiki/Peer_review Therefore, it already includes the "human" touch of the original sentence.