Simplify High-scores exercise. Replace Class with functions #1764
Conversation
Exercise text edited. Tests made to expect functions. One test removed, cause was no longer valid. Make new example.py using functions. Add the functions as starting point in the exercise file. (This also make the tests not complain of missing imports and such.) Added __init__.py to the package for the people that still run 2.7+ Added pytest cache to gitignore file
Remove __init__.py Remove content of HINTS.md Generate the README.md Remove the comments in stub file
|
All Changes made. |
|
|
||
| - [**A First Look at Classes**](https://docs.python.org/3/tutorial/classes.html#a-first-look-at-classes) from the Python 3 documentation. | ||
| - [**How to Define a Class in Python**](https://realpython.com/python3-object-oriented-programming/#how-to-define-a-class-in-python) from the Real Python website. | ||
| - [**Data Structures in Python**](https://docs.python.org/3/tutorial/datastructures.html) from the Python 3 documentation. |
There was a problem hiding this comment.
I'd like to ping @BethanyG for suggestions on new HINTS content. She put some good work into the current HINTS.md (less than a month ago), and I would feel bad about dumping that work without offering the chance to contribute an alternative.
There was a problem hiding this comment.
I'm happy to write up some new hints...but I think the bigger issue here is that if you remove making a class in this exercise (which is a fairly easy one), then when students have to make a class (and deal with side effect questions) in the next exercise..well, we've just kicked the can down the road. The same issues that apply to High Scores apply to Matrix (and Kindergarten Garden, etc.) ...and eventually, a python learner has to to deal with classes. They're part of the language (it's really is objects all the way down), and widely used in frameworks like Django. The sooner students get (even a little) practice in a controlled fashion, the less they struggle later.
So the way I see it is that we either have to craft an exercise or two around classes and mutability specifically, or re-work tests and mentor notes on current exercises to address it. I don't think the answer is to re-write this exercise (and the next) to not need a class. If we don't want a class-based exercise here because we want to focus on lists, we could move this exercises to a later stage (and address its shortcomings through a re-write of tests). We could replace it with something like Say or Run Length Encoding - or any other number of exercises that focus on lists and arrays. But only 6 of 18 core exercises require writing a class currently, and I'm not sure we are doing a great job of giving students practice in that area.
All that being said....if we do indeed want to make this exercise function based, I can try to make some new hints this week. However, we then should move these hints to the Matrix exercise, since it will then be the exercise to introduce classes. We maybe should also provide a hint on mutability there as well.
There was a problem hiding this comment.
Apologies - forgot one last point: We'll need to re-work the mentor notes for this exercise as well. I don't think I will be able to get to either that or the hints until this afternoon, PST.
There was a problem hiding this comment.
So the way I see it is that we either have to craft an exercise or two around classes and mutability specifically
I'm not opposed to that.
If we don't want a class-based exercise here because we want to focus on lists, we could move this exercises to a later stage (and address its shortcomings through a re-write of tests).
There are very few easy exercises as it is. I'd prefer not to overcomplicate what was meant to be a simple list exercise.
All that being said....if we do indeed want to make this exercise function based, I can try to make some new hints this week. However, we then should move these hints to the Matrix exercise, since it will then be the exercise to introduce classes. We maybe should also provide a hint on mutability there as well.
I can get behind that.
There was a problem hiding this comment.
Ok - I wasn't able to make suggestions in the pull (I don't have access) - but here's my proposed hint text:
In this exercise, you're going to use and manipulate lists. Python lists are very versatile, and you'll find yourself using them again and agin in problems both simple and complex.
- Data Structures (Python 3 Documentation Tutorial)
- Lists and Tuples in Python (Real Python)
- Python Lists (Google for Education)
I'll submit a pull for revised mentor notes and for the new hint on Matrix.
There was a problem hiding this comment.
See exercism/website-copy#956 for the updated mentor notes.
There was a problem hiding this comment.
Thanks @BethanyG :)
I will add the new hints right now :)
And actually will push the old hints to Matrix in this PR. So we did not loose them.
For me Matrix is better Class based exercise. But we can make other also.
There was a problem hiding this comment.
Would you mind creating a separate PR for the changes to matrix? We try to limit PR changes to one exercise at a time (there are few exceptions).
There was a problem hiding this comment.
Well doesn't that count as exception? We have not changed the exercise in Matrix, just add the hints because previously they ware available at this exercise?
I can open other PR is not a big deal, but we have to merge them one after the other. I thought it would be better if we push this as one change.
I will make new one tomorrow morning and will edit this one to remove matrix docs.
There was a problem hiding this comment.
I don't have an issue with both exercises temporarily having the same generic hints about classes, so I went ahead and merged #1766.
Added hints for some docs around list and tuples - thanks @BethanyG for that Moved original hints for classes in matrix ( cause is the next exercise for now which use class) slightly edited to not refer to high-score Regenerate both README.md
|
Moved changes to Matrix in separate PR: #1766 |
Co-Authored-By: simmol <[email protected]>
Co-Authored-By: simmol <[email protected]>
|
I had applied the comments. Sorry for late response but I was on vacation. |
exercises/high-scores/README.md
Outdated
| - [**A First Look at Classes**](https://docs.python.org/3/tutorial/classes.html#a-first-look-at-classes) from the Python 3 documentation. | ||
| - [**How to Define a Class in Python**](https://realpython.com/python3-object-oriented-programming/#how-to-define-a-class-in-python) from the Real Python website. | ||
| - [**Data Structures in Python**](https://docs.python.org/3/tutorial/datastructures.html) from the Python 3 documentation. | ||
| In this exercise, you're going to use and manipulate lists. Python lists are very versatile, and you'll find yourself using them again and agin in problems both simple and complex. |
There was a problem hiding this comment.
You'll need to run configlet generate one more time to get Travis to pass. We should be good after that!
There was a problem hiding this comment.
Will see to do it later today or first thing in the morning.
|
@cmccandless I think this is all for this PR :) |
|
Merged; thanks for working on this! |
As discussed with @cmccandless in #1744, i submit a PR for simplifying high score exercise.
Exercise text edited.
Tests made to expect functions. One test removed, cause was no longer valid.
Make new example.py using functions.
Add the functions as starting point in the exercise file. (This also make the tests not complain of missing imports and such.)
Added init.py to the package for the people that still run 2.7+
Added pytest cache to gitignore file