Drasil
Drasil copied to clipboard
JacquesCarette
Improve documentation for `Linearity`
Which documentation am I required to change? I guess it has to be SRS, however, then the second problem is, where is the position should I add it in? All sections do not have relevant content with this part of the code. I guess it is elsewhere in the code, but I am unsure. @samm82
The issue title seems to be a bit misleading; I think the actual task here is that Linearity (see below) should be changed to something that makes more sense (following the linked issue), including its documentation (the comment above its definition).
https://github.com/JacquesCarette/Drasil/blob/d5afe5c61d5fac443a5eac96fef5856bf07454e8/code/drasil-printers/lib/Language/Drasil/Plain/Print.hs#L28-L29
@samm82 In this issue, I feel I only need to change documentation (nothing needed to change with the code) Is this correct?
That's what I meant by this comment:
The issue title seems to be a bit misleading; I think the actual task here is that
Linearityshould be changed to something that makes more sense (following the linked issue), including its documentation.
The main issue is actually to change the names of Linearity, Linear, and Nonlinear. Once these names (and the comment above them, its "documentation") are changed in their definition and wherever they're used, this shouldn't have an effect on the generated output.
@samm82 So there are two parts of work in this issue: change the code and the documentation.
For the code I am going to replace the definition name with this: data SingleLine = OneLine | MultiLine, while its corresponding comments need to be changed too. (Some of them still have references with the name "Linearity")
@samm82 For the second part (documentation), where is the corresponding documentation position for Linearity? I searched all documents in SRS, but I feel there are no occurrences of the word "Linearity". (Not only in the SRS, it does not occur elsewhere)
As you can see the evidence below, only one file contains "Linearity", and this file is not a documentation:
Right, documentation can refer to "generated documentation for our code examples" OR "manual documentation for our Drasil code". This specific usage refers to the second, not the first; updating the comment above the definition of the new data SingleLine is what we're looking for