Corgi239 commented 2 years ago

Description

In "Hello Python: grading steps in detail" section, step 17, the decorator @points(1) is said to give 5 points, which it should presumably be said to give just 1 point. I edited the corresponding .rst file to reflect this.

Why?

To prevent confusion about how the @points(n) decorator works.

How?

Replaced "five points" with "one point" in the .rst file containing the corresponding material.

Testing

No testing was carried out.

What type of test did you run?

[ ] Accessibility test using the WAVE extension.
[ ] Django unit tests.
[ ] Selenium tests.
[ ] Other test. (Add a description below)
[ ] Manual testing.

Did you test the changes in

[ ] Chrome
[ ] Firefox
[ ] This pull request cannot be tested in the browser.

Think of what is affected by these changes and could become broken

Translation

[ ] Did you modify or add new strings in the user interface? (Read about how to create translation)

Programming style

[ ] Did you follow our style guides?
[ ] Did you use Python type hinting in all functions that you added or edited? (type hints for function parameters and return values)

Have you updated the README or other relevant documentation?

[ ] documents inside the doc directory.
[ ] README.md.
[ ] Aplus Manual.
[ ] Other documentation (mention below which documentation).

Is it Done?

[ ] Reviewer has finished the code review
[ ] After the review, the developer has made changes accordingly
[ ] Customer/Teacher has accepted the implementation of the feature

Clean up your git commit history before submitting the pull request!

markkuriekkinen commented 2 years ago

@ihalaij1 any thoughts on this? :smile:

markkuriekkinen commented 2 years ago

The commit message is a bit off. Very long lines in the body and the message unnecessarily repeats information that is part of the code. There is no need to write the code line numbers in the commit message.

ihalaij1 commented 2 years ago

@ihalaij1 any thoughts on this? 😄

This was indeed wrong in the RST. Good fix!