Skip to content

Fix doubled words in three docstrings - #6129

Open
marekl11 wants to merge 1 commit into
learningequality:unstablefrom
marekl11:fix/docstring-typos
Open

Fix doubled words in three docstrings#6129
marekl11 wants to merge 1 commit into
learningequality:unstablefrom
marekl11:fix/docstring-typos

Conversation

@marekl11

@marekl11 marekl11 commented Sep 3, 2026

Copy link
Copy Markdown

Three docstrings with a repeated word: "are the the expected ones" in
test_chef_pipeline.py and "children data for for the node" in
views/internal.py. The third, in test_gcs_storage.py, read "Check that set
set a cache-control of private" - that one was missing a word rather than
repeating one, so it now reads "Check that we set a cache-control".

AI usage

  • Disclose: I used Claude Code to search for repeated words in
    docstrings and comments, and to apply the resulting one-word edits.
  • Engage critically: I read each hit in context rather than taking
    the search at face value, and confirmed none of the three strings is
    asserted on by a test or used as a translation key.
  • Edit: the third hit needed rewriting rather than de-duplicating -
    "Check that set set a cache-control of private" is a missing word, not
    a repeated one, so it now reads "Check that we set a cache-control".
  • Process sharing: the lesson worth passing on is that a
    doubled-word search returns three different kinds of hit - real
    duplicates, missing words, and deliberate repetition - so the
    candidates have to be read individually. Here one of three was not a
    plain duplicate.

Docstrings only; no code paths, tests or user-facing text change.

"the the expected ones" in test_chef_pipeline, "data for for the node"
in views/internal, and "Check that set set a cache-control" in
test_gcs_storage, which was missing a word rather than repeating one.
@learning-equality-bot

Copy link
Copy Markdown

👋 Hi @marekl11, thanks for contributing!

For the review process to begin, please verify that the following is satisfied:

  • Contribution is aligned with our contributing guidelines

  • Pull request description has correctly filled AI usage section & follows our AI guidance:

    AI guidance

    State explicitly whether you didn't use or used AI & how.

    If you used it, ensure that the PR is aligned with Using AI as well as our DEEP framework. DEEP asks you:

    • Disclose — Be open about when you've used AI for support.
    • Engage critically — Question what is generated. Review code for correctness and unnecessary complexity.
    • Edit — Review and refine AI output. Remove unnecessary code and verify it still works after your edits.
    • Process sharing — Explain how you used the AI so others can learn.

    Examples of good disclosures:

    "I used Claude Code to implement the component, prompting it to follow the pattern in ComponentX. I reviewed the generated code, removed unnecessary error handling, and verified the tests pass."

    "I brainstormed the approach with Gemini, then had it write failing tests for the feature. After reviewing the tests, I used Claude Code to generate the implementation. I refactored the output to reduce verbosity and ran the full test suite."

Also check that issue requirements are satisfied & you ran pre-commit locally.

Pull requests that don't follow the guidelines will be closed.

Reviewer assignment can take up to 2 weeks.

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