Skip to content

chore: Sync exercise documentation via configlet #856

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

Open
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

rabestro
Copy link
Member

This PR updates the documentation (instructions and introductions) for 21 Practice Exercises in the Scala track to bring them in sync with the central problem-specifications repository.

The updates were automatically generated by running the following command:

./bin/configlet sync --update --docs

This addressed synchronization warnings for the following exercises:

  • anagram (instructions)
  • atbash-cipher (instructions)
  • change (instructions)
  • collatz-conjecture (instructions)
  • complex-numbers (instructions)
  • dominoes (instructions)
  • flatten-array (instructions)
  • grade-school (instructions)
  • grains (instructions)
  • hamming (instructions)
  • luhn (instructions)
  • meetup (instructions)
  • pascals-triangle (introduction)
  • phone-number (instructions)
  • protein-translation (instructions)
  • pythagorean-triplet (instructions)
  • rna-transcription (instructions)
  • saddle-points (instructions)
  • sieve (instructions)
  • simple-cipher (instructions)
  • sublist (instructions)

This ensures that learners on the Scala track receive the latest, standardized documentation for these exercises. No manual changes were made beyond running the sync command.

Jegors Cemisovs added 21 commits April 28, 2025 08:37
Refactored the instructions for clarity and conciseness. Reworded sentences to improve readability, removed redundancies, and ensured consistency in terminology.
Corrected the capitalization of "Atbash" to align with proper noun usage. This improves clarity and ensures consistency in the documentation.
Simplified the instructions to enhance readability. Improved example formatting and adjusted phrasing for better consistency and understanding. Removed unnecessary edge case prompts.
Condense the explanation and examples into a single concise sentence. This improves readability and removes redundant details while preserving the core instruction."
Expanded the instructions to include comprehensive descriptions of complex number properties and operations, such as conjugate, absolute value, addition, subtraction, multiplication, division, and exponentiation. Also laid out the implementation expectations clearly, specifying that built-in complex number support should not be used.
Reworded the instructions for improved readability and clarity. Broke down the description into concise sentences for easier understanding of the domino chain rules.
Refined the description to specify handling of nested arrays of any depth. Clarified treatment of null-like values and included a more comprehensive example to align with varying language tracks.
Refine phrasing to improve readability and fix minor grammatical issues in the instructions. Changes include better sentence structure, corrected punctuation, and consistent formatting for examples. These adjustments enhance comprehension while keeping the content precise and professional.
Streamlined the problem description for clarity and conciseness. Replaced the narrative with a straightforward explanation of the chessboard grain-doubling concept and adjusted the tasks accordingly.
Removed extraneous context about DNA replication and cell division to focus solely on calculating the Hamming distance. This improves clarity and keeps the instructions concise and relevant.
Provide clearer explanations for validating numbers using the Luhn algorithm. Refine examples with improved formatting, additional context, and concise steps for both valid and invalid cases.
Corrected the number of week values listed in the instructions to ensure accuracy. This change improves clarity and aligns the documentation with the problem requirements.
Adjusted the wording in the instructions to make them more concise, removing "user-entered" for clarity. This improves readability without changing the intended meaning.
Replaced "polypeptide" with "protein" and standardized language for consistency. Adjusted capitalization of "amino acids" and updated table column header for accuracy.
Updated the title in the Pythagorean triplet exercise documentation for better clarity and consistency with naming conventions. This change improves readability and aligns terminology with project standards.
Correct missing conjunctions and punctuation in the RNA transcription exercise instructions. These changes enhance readability and maintain consistency in formatting.
Added arrows and brackets to improve readability of the example grid, making it easier to identify the candidate treehouse location. This enhances comprehension for users working on the exercise.
Refined explanation of the Sieve of Eratosthenes for better readability and accuracy. Added detailed steps, examples, and visuals to make the process easier to follow, highlighting primes and marked numbers. Improved notes to emphasize algorithm implementation details.
Updated the usage of "Caesar Cipher" to "Caesar cipher" for consistent capitalization throughout the instructions. This improves readability and maintains uniform naming conventions.
Updated the instructions to specify that sublists and superlists must consist of contiguous sub-sequences. This improves clarity and aligns with the intended problem definition.
Corrected "lookup" to "look up" for grammatical accuracy. Ensures the documentation maintains a professional and polished standard.
Copy link

Hello 👋 Thanks for your PR.

This repo does not currently have dedicated maintainers. Our cross-track maintainers team will attempt to review and merge your PR, but it will likely take longer for your PR to be reviewed.

If you enjoy contributing to Exercism and have a track-record of doing so successfully, you might like to become an Exercism maintainer for this track.

Please feel free to ask any questions, or chat to us about anything to do with this PR or the reviewing process on the Exercism forum.

(cc @exercism/cross-track-maintainers)

@rabestro rabestro mentioned this pull request Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant