Skip to content

Sync simple cipher#1025

Open
Narkunan wants to merge 7 commits into
exercism:mainfrom
Narkunan:sync-simple-cipher
Open

Sync simple cipher#1025
Narkunan wants to merge 7 commits into
exercism:mainfrom
Narkunan:sync-simple-cipher

Conversation

@Narkunan

Copy link
Copy Markdown
Contributor

Fix issue #987

@github-actions

Copy link
Copy Markdown

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.

[no important files changed]

For more information, refer to the documentation. If you are unsure whether to add the message or not, please ping @exercism/maintainers-admin in a comment. Thank you!

@mk-mxp mk-mxp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for helping! Please go through all UUID comments and adjust them as stated below.

Looking forward to the next iteration!

Comment on lines 2 to 8
"authors": [
"camilopayan"
"camilopayan",
"Narkunan"
],
"contributors": [
"MichaelBunker"
],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may add yourself as contributor, not author 😄

  "authors": [
    "camilopayan"
  ],
  "contributors": [
    "MichaelBunker",
    "Narkunan"
  ],

Comment on lines +30 to +32
/**
* Uuid: 3dff7f36-75db-46b4-ab70-644b3f38b81c.
*/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/**
* 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not add a dot at the end of the UUIDs:

Suggested change
* Uuid: b8bdfbe1-bea3-41bb-a999-b41403f2b15d.
* Uuid: b8bdfbe1-bea3-41bb-a999-b41403f2b15d

Comment on lines +41 to 45
/**
* 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a real special case. The example should not be in the TestDox.

Suggested change
/**
* 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

Comment on lines +52 to +54
/**
* Uuid: defc0050-e87d-4840-85e4-51a1ab9dd6aa.
*/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
/**
* 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please adjust the method names to match the TestDox sentence.

Suggested change
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')]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, it's better to skip the example here:

Suggested change
#[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')]

@mk-mxp mk-mxp added x:action/sync Sync content with its latest version x:knowledge/elementary Little Exercism knowledge required x:module/practice-exercise Work on Practice Exercises x:type/content Work on content (e.g. exercises, concepts) x:size/small Small amount of work x:rep/small Small amount of reputation labels Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

x:action/sync Sync content with its latest version x:knowledge/elementary Little Exercism knowledge required x:module/practice-exercise Work on Practice Exercises x:rep/small Small amount of reputation x:size/small Small amount of work x:type/content Work on content (e.g. exercises, concepts)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants