-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Fix all entries with wrong output for number_to_the_power_of.__doc__ #2837
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
…_power_of function
|
Hi & Welcome! 👋🏽 👋 Thank you for contributing to This is an automated [🤖 🤖 ] comment for the
|
|
✅️ Have You Checked:
|
.
|
🛠️ Maintainers
Please take note 📒 of the following sections/review items 👀 ✨
🌈 Acknowledgements and Reputation
|
💫 General Code Quality
- The branch was updated & rebased with any (recent) upstream changes.
- All prose was checked for spelling and grammar.
- Files are formatted via yapf (yapf config) & conform to our coding standards
- Files pass flake8 with flake8 config & pylint with pylint config.
- Changed
example.py/exemplar.pyfiles still pass their associated test files. - Changed test files still work with associated
example.py/exemplar.pyfiles.- Check that tests fail properly, as well as succeed.
(e.g., make some tests fail on purpose to "test the tests" & failure messages).
- Check that tests fail properly, as well as succeed.
- All files have proper EOL.
- If a
JinJa2template was modified/created, was the test file regenerated?- Does the regenerated test file successfully test the exercises
example.pyfile?
- Does the regenerated test file successfully test the exercises
- The branch passes all CI checks &
configlet-lint.
Verify: |
🌿 Changes to Concept Exercises
- ❓ Are all required files still up-to-date & configured correctly for this change?_
- ❓ Does
<exercise>/.meta/design.mdneed to be updated with new implementation/design decisions - ❓ Do these changes require follow-on/supporting changes to related concept documents?
- Exercise
introduction.md- Do all code examples compile, run, and return the shown output?
- Are all the code examples formatted per the Python docs?
- Exercise
instructions.md - Exercise
hints.md - Check that exercise
design.mdwas fulfilled or edited appropriately - Exercise
exemplar.py- Only uses syntax previously introduced or explained.
- Is correct and appropriate for the exercise and story.
- Exercise
<exercise_name>.py(stub)- Includes appropriate docstrings and function names.
- Includes
passfor each function - Includes an EOL at the end
- Exercise
<exercise_name>_test.py- Tests cover all (reasonable) inputs and scenarios
- At least one test for each task in the exercise
- If using subtests or fixtures they're formatted correctly for the runner
- Classnames are
<ExerciseName>Test - Test functions are
test_<test_name>
- Exercise
config.json--> valid UUID4 - Corresponding concept
introduction.md - Corresponding concept
about.md - Concept
config.json - All Markdown Files : Prettier linting (for all markdown docs)
- All Code files: PyLint linting (except for test files)
- All files with text: Spell check & grammar review.
✨ Where applicable, check the following ✨
|
(as a reminder: Concept Exercise Anatomy) |
🚀 Changes to Practice Exercises
-
.docs/instructions.md(required)- Was this file updated and regenerated properly?
-
.docs/introduction.md(optional) -
.docs/introduction.append.md(optional) -
.docs/instructions.append.md(optional)- Are any additional instructions needed/provided?
(e.g. error handling or information on classes)
- Are any additional instructions needed/provided?
-
.docs/hints.md(optional)- Was this file regenerated properly?
-
.meta/config.json(required) -
.meta/example.py(required)- Does this pass all the current tests as written/generated?
-
.meta/design.md(optional) -
.meta/template.j2(template for generating tests from canonical data)- Was a test file properly regenerated from this template?
-
.meta/tests.toml- Are there additional test cases to include or exclude?
- Are there any Python-specific test cases needed for this exercise?
-
<exercise-slug>_test.py- Does this file need to be regenerated?
- Does this file correctly test the
example.pyfile? - Does this file correctly report test failures and messages?
-
<exercise-slug>.py(required)- Does this stub have enough information to get
the student started coding a valid solution?
- Does this stub have enough information to get
|
Is the exercise is in line with Practice Exercise Anatomy? |
🐣 Brand-New Concept Exercises
- Exercise
introduction.md- Do all code examples compile, run, and return the shown output?
- Are all the code examples formatted per the Python docs?
- Exercise
instructions.md - Exercise
hints.md - Check that exercise
design.mdwas fulfilled or edited appropriately - Exercise
exemplar.py- Only uses syntax previously introduced or explained.
- Is correct and appropriate for the exercise and story.
- Exercise
<exercise_name>.py(stub)- Includes appropriate docstrings and function names.
- Includes
passfor each function - Includes an EOL at the end
- Exercise
<exercise_name>_test.py- Tests cover all (reasonable) inputs and scenarios
- At least one test for each task in the exercise
- If using subtests or fixtures they're formatted correctly for the runner
- Classnames are
<ExerciseName>Test - Test functions are
test_<test_name>
- Exercise
config.json--> valid UUID4 - Corresponding concept
introduction.md - Corresponding concept
about.md - Concept
config.json - All Markdown Files : Prettier linting (for all markdown docs)
- All Code files: Flake8 & PyLint linting
- All Code Examples: proper formatting and fencing. Verify they run in the REPL
- All files with text: Spell check & grammar review.
|
Is the exercise is in line with Concept Exercise Anatomy? |
Our 💖 for all your review efforts! 🌟 🦄
|
@mlistewnik -- I think that between me leaving comments and when you tried to add additional changes we merged several other PRs, so that might have done something to yours -- although you should have been able to pull changes an rebase and continue. Strange. |
BethanyG
left a comment
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.
Thank you for being so through, and for finding that last example. 🌟
We really appreciate this PR - nice work!
|
Hi, |
|
Hi @mlistewnik - I will not even pretend to be any sort of This Atlassian article on rebasing helps explain the scenario, and this one on the golden rule of rebasing explains some of the pitfalls. If you had rebased, the merged PRs would be added into your commit chain based on when they were introduced to |
|
On 22/01/03 10:56AM, BethanyG wrote:
This Atlassian article on
[rebasing](https://www.atlassian.com/git/tutorials/merging-vs-rebasing)
helps explain the scenario, and this one on the [golden rule of
rebasing](https://www.atlassian.com/git/tutorials/merging-vs-rebasing#the-golden-rule-of-rebasing)
explains some of the pitfalls.
Good resources, (a little bit too "scary" on the golden rule part, in
that "public" is a little bit too broad but it) gives a good baseline to
work from.
If you had rebased, the merged PRs would be added into your commit
chain based on when they were introduced to `main` ***@***.*** please
correct me if I am wrong here!!_**), so yes -- those changes might
appear _before_ your newest changes -- but after your first ones.
If the branch or your repository where the work was done had rebased
your changes onto `exercism/python/main` then that would be OK, but you
do not want to rebase main onto your changes. But as long as we
understand the target of the rebase, and that target is (usually)
`origin/main` then yes, that is correct.
|
Hi @BethanyG, I read your comments to the previous PR and checked for all instances of the docstring to
number_to_the_power_offunction.I found one more instance, altogether 3 files were changed.
This PR relates to issue: #2833
Note 1: Prettier suggests to add one more line after
>>> print(number_to_the_power_of.__doc__)but I kept the same distance as in the original, because it's supposed to show how the REPL prints output, so I guess not having that blank line is fine?Note 2: I wanted to update the already created PR (#2834), but some of my changes (updated branch to be in sync with main) must have automatically closed it.