Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rewrite the Simple Cipher description. #2565
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Rewrite the Simple Cipher description. #2565
Changes from all commits
7d8f778
a9329ac
44486e1
2988301
116343a
d7332e0
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to put this example in its own subsection and show the process in more detail? For instance: "e" is shifted by 1, so it becomes the next letter, "f". "l" is shifted by 2, so it becomes the letter two positions after "l", and so on. For "o", we've run out of key letters, so we start over with "a", and the shift is 0. Basically, just more explanation about how the instructions are applied to the example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤷
Either way makes sense. I think this is detailed enough to get students started. Do you think it needs to be more detailed for students to understand the algorithm and solve this exercise?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW no one on the forum asked for more detail here, implicitly suggesting they feel this is sufficiently detailed as is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, this is enough to get started. It's enough for me since I already understand how the algorithm works, and it's probably enough for someone who figures it out from the input and output. So if the goal is for students to work out the algorithm based on the description and tests, then the given instructions are probably sufficient. It really depends on what you have in mind. Personally, I would prefer to see the algorithm in action to make things clearer. Even a simple rephrasing would help:
If the plaintext is "hello" and the key is "abcd", the letters `h, e, l, l, o` are shifted by `0, 1, 2, 3, 0` positions respectively, resulting in "hfnoo".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So ... to clarify what you're saying, you specifically would like the example which calls out/shows the part about how the key is repeated?