-
-
Notifications
You must be signed in to change notification settings - Fork 556
affine-cipher: Updates to the exercise instructions file #1857
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
Conversation
Hi, I have tried to clean up the instructions to this exercise a bit and possibly make them a bit more informative by: * Changing the markdown text from plain to `code` for important values to let them stand out * Adding the Encryption and Decryption section headers for improved clarity * Adding guidance about digits and spaces as inputs to match the test cases * Updating the Decryption formula to avoid exponent ambiguity * Updated the MMI property formula to be more consistent with the resource (Wiki), and subjectively easier to grasp * Adding a hint about what coprimes (or relative primes) are for improved clarity * Removing one example of MMI which seemed to be redundant Please review the proposed updates and let me know what you think - they are subjective so it's perfectly fine if only some / none of them will be accepted. Thank you for your time!
The update was originally submitted for the F# path but was moved here, based on maintainers request. |
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.
these changes all seem agreeable, as they are improvements.
I am obligated to object to the use of "here" as link text.
I have some optional changes that could additionally be made.
Updates: * Replaced "here" with more descriptive text for clarity * Removed requirement to return error code `1` as it is language dependent * Capitalized Roman
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 with all suggestions @petertseng made.
I hope I did everything correctly; this is the first time I am doing this kind of "back-and-forth" PR. |
OK. Co-authored-by: Erik Schierboom <[email protected]>
Ok. Thanks! Co-authored-by: Erik Schierboom <[email protected]>
Maybe it's just the way it is displayed in my browser; but it seems that although you have continued the existing style in the file of hard line wraps at a specific column count, you have used a different column count to the rest of the file. Alternative may be to convert entire file to the preferred style of no hard wraps with instead a new line for each sentence. |
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.
although I have a suggestion, I will approve anyway because the current text is still an improvement over the original, and the suggestions I'm making are essentially changing text that was already there in the version before this PR
Co-authored-by: Peter Tseng <[email protected]>
Co-authored-by: Peter Tseng <[email protected]>
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.
happy with this now. maybe one more, but I don't want to give the impression that I am going to keep on piling one small change after another in each successive review. It's good as-is from what I can see.
Thanks a lot @onpikono! |
Thank you and all the others involved! |
Hi, I have tried to clean up the instructions to this exercise a bit and possibly make them a bit more informative by:
code
for important values to let them stand outPlease review the proposed updates and let me know what you think - they are subjective so it's perfectly fine if only some / none of them will be accepted. Thank you for your time!