nucleotide-count: Refactoring the description #913
Conversation
I have tried to be more precise, specific and accurate. I am not sure what you are trying to accomplish with this description, so please let me know if you need any further help if the description expands.
rpottsoh
changed the title
| @@ -1,25 +1,13 @@ | |||
| Given a DNA string, compute how many times each nucleotide occurs in the string. | |||
| Given a single stranded DNA string, compute how many times each nucleotide occurs in the string. | |||
There was a problem hiding this comment.
This sentence looks like it covers the point you raised in #902. The rest of the changes are interesting, and I don't think they are bad, but I am not sure that they are necessary. I am curious to read other peoples thoughts on this.
There was a problem hiding this comment.
I made an effort not to bring in much new information. I simply structured the sentences and information already there to be more precise and accurate in accordance with biochemical discourse.
You may use my changes as you like :)
|
@Dysp thanks for creating this PR. The description.md is simply intended to describe the problem that the student will be trying to solve. This file becomes the basis of the readme.md that is delivered to the student via the CLI. This repo's readme.md has a short blurb about the description.md file. I am sure someone can point you to a better description of the file. Sometimes locating the best documentation for a given set of circumstances can be a little tricky. |
|
I, being a computer scientist rather than a biochemist, think these changes are an improvement to the description of DNA. It contains the main information about the characters used to represent the nucleotides. I might leave the bit about RNA out of this description as it is not at all relevant to the DNA nucleotide counting task. The description of this problem has always been a bit informal. There are other things that could be done to explain the task in programming terms, but that is out of scope for this PR which is about improving the biochemical accuracy of the description. |
|
Thanks for caring and taking the time to improve this exercise. 🥇 If you plan to make any of the other changes @Insti suggested just submit another commit to this PR with your changes. Give me a 👍 or post a comment if you are finished and I'll see that this PR is merged. @Insti is right about this:
If you want to pursue changes along this line, I would hold off until this PR is merged. |
|
@Dysp I am going to go ahead and merge this PR. If you would like to to make any further changes please feel free to open a new PR. Thanks again for your efforts in improving the description for this exercise! |
|
|
||
| RNA contains a slightly different set of nucleotides, but we don't care | ||
| about that for now. | ||
| In RNA the thymine is substituted with 'U' for uracil, while the remainder stay the same; A, U, C, G. |
There was a problem hiding this comment.
I don't think this information is necessary for this exercise, and including it will cause confusion. A student would naturally ask "Why did you tell me this? Why do I need to know this?"
I have tried to be more precise, specific and accurate.
I am not sure what you are trying to accomplish with this description, so please let me know if you need any further help if the description expands.