Skip to main content
replaced http://codereview.stackexchange.com/ with https://codereview.stackexchange.com/
Source Link

My instinct is to say that documentation is not code, and thus is not reviewable.... We have had a number of discussions about pseudocode, and they have all resulted in 'we do not review pseudocode', and 'we do not review pseudocode' (on-topic item #3)'we do not review pseudocode' (on-topic item #3).

Documentation is close to pseudocode.... right?

In general, certain languages have documentation styles, so, in the sense that the documentation is really directives to a documentation-engine (Javadoc, pod, DoxyGen)... still, it is not a language, and it is not a program.

My vote is 'NO, we do not review documentation'.

My instinct is to say that documentation is not code, and thus is not reviewable.... We have had a number of discussions about pseudocode, and they have all resulted in 'we do not review pseudocode', and 'we do not review pseudocode' (on-topic item #3).

Documentation is close to pseudocode.... right?

In general, certain languages have documentation styles, so, in the sense that the documentation is really directives to a documentation-engine (Javadoc, pod, DoxyGen)... still, it is not a language, and it is not a program.

My vote is 'NO, we do not review documentation'.

My instinct is to say that documentation is not code, and thus is not reviewable.... We have had a number of discussions about pseudocode, and they have all resulted in 'we do not review pseudocode', and 'we do not review pseudocode' (on-topic item #3).

Documentation is close to pseudocode.... right?

In general, certain languages have documentation styles, so, in the sense that the documentation is really directives to a documentation-engine (Javadoc, pod, DoxyGen)... still, it is not a language, and it is not a program.

My vote is 'NO, we do not review documentation'.

replaced http://meta.codereview.stackexchange.com/ with https://codereview.meta.stackexchange.com/
Source Link
replaced http://meta.codereview.stackexchange.com/ with https://codereview.meta.stackexchange.com/
Source Link
replaced http://meta.codereview.stackexchange.com/ with https://codereview.meta.stackexchange.com/
Source Link
Loading
Fixed formatting.
Source Link
user35408
user35408
Loading
Source Link
rolfl
  • 98.1k
  • 4
  • 117
  • 238
Loading