Sync simple cipher#1025
Conversation
|
This PR touches files which potentially affect the outcome of the tests of an exercise. This will cause all students' solutions to affected exercises to be re-tested. If this PR does not affect the result of the test (or, for example, adds an edge case that is not worth rerunning all tests for), please add the following to the merge-commit message which will stops student's tests from re-running. Please copy-paste to avoid typos. For more information, refer to the documentation. If you are unsure whether to add the message or not, please ping |
mk-mxp
left a comment
There was a problem hiding this comment.
Thank you for helping! Please go through all UUID comments and adjust them as stated below.
Looking forward to the next iteration!
| "authors": [ | ||
| "camilopayan" | ||
| "camilopayan", | ||
| "Narkunan" | ||
| ], | ||
| "contributors": [ | ||
| "MichaelBunker" | ||
| ], |
There was a problem hiding this comment.
You may add yourself as contributor, not author 😄
"authors": [
"camilopayan"
],
"contributors": [
"MichaelBunker",
"Narkunan"
],| /** | ||
| * Uuid: 3dff7f36-75db-46b4-ab70-644b3f38b81c. | ||
| */ |
There was a problem hiding this comment.
| /** | |
| * Uuid: 3dff7f36-75db-46b4-ab70-644b3f38b81c. | |
| */ | |
| /** | |
| * Uuid: 3dff7f36-75db-46b4-ab70-644b3f38b81c | |
| */ |
| * output the key. This is a critical problem with shift ciphers, some | ||
| * characters will always output the key verbatim. | ||
| * | ||
| * Uuid: b8bdfbe1-bea3-41bb-a999-b41403f2b15d. |
There was a problem hiding this comment.
Please do not add a dot at the end of the UUIDs:
| * Uuid: b8bdfbe1-bea3-41bb-a999-b41403f2b15d. | |
| * Uuid: b8bdfbe1-bea3-41bb-a999-b41403f2b15d |
| /** | ||
| * Uuid: 8143c684-6df6-46ba-bd1f-dea8fcb5d265. | ||
| */ | ||
| #[TestDox('Random key cipher -> Is reversible. I.e., if you apply decode in a encoded result, you must see the same plaintext encode parameter as a result of the decode method')] | ||
| public function testRandomKeyCipherReversible(): void |
There was a problem hiding this comment.
This is a real special case. The example should not be in the TestDox.
| /** | |
| * Uuid: 8143c684-6df6-46ba-bd1f-dea8fcb5d265. | |
| */ | |
| #[TestDox('Random key cipher -> Is reversible. I.e., if you apply decode in a encoded result, you must see the same plaintext encode parameter as a result of the decode method')] | |
| public function testRandomKeyCipherReversible(): void | |
| /** | |
| * Uuid: 8143c684-6df6-46ba-bd1f-dea8fcb5d265. | |
| */ | |
| #[TestDox('Random key cipher -> Is reversible')] | |
| public function testRandomKeyCipherReversible(): void |
| /** | ||
| * Uuid: defc0050-e87d-4840-85e4-51a1ab9dd6aa. | ||
| */ |
There was a problem hiding this comment.
Please go through all DocBlocks and fix the indentation. 4 spaces on the comment starting line, then 5 spaces until the comment ends. That's the rule. And no dot after the UUID.
| /** | |
| * Uuid: defc0050-e87d-4840-85e4-51a1ab9dd6aa. | |
| */ | |
| /** | |
| * Uuid: defc0050-e87d-4840-85e4-51a1ab9dd6aa | |
| */ |
| * Uuid: b8bdfbe1-bea3-41bb-a999-b41403f2b15d. | ||
| */ | ||
| #[TestDox('Random key cipher -> Can encode')] | ||
| public function testRandomKeyCipherEncode(): void |
There was a problem hiding this comment.
Please adjust the method names to match the TestDox sentence.
| public function testRandomKeyCipherEncode(): void | |
| public function testRandomKeyCipherCanEncode(): void |
| /** | ||
| * Uuid: 70a16473-7339-43df-902d-93408c69e9d1. | ||
| */ | ||
| #[TestDox('Substitution cipher -> Is reversible. I.e., if you apply decode in a encoded result, you must see the same plaintext encode parameter as a result of the decode method')] |
There was a problem hiding this comment.
Again, it's better to skip the example here:
| #[TestDox('Substitution cipher -> Is reversible. I.e., if you apply decode in a encoded result, you must see the same plaintext encode parameter as a result of the decode method')] | |
| #[TestDox('Substitution cipher -> Is reversible')] |
Fix issue #987