py-lambdas / code-challenges Goto Github PK

1. In
   "How do I get started?
   Fork this repository and start coding away!🚀 Test your solution by running the associated unit test. When you are reading to submit, submit a Pull Request to the submissions branch with your solution."

I believe that 'reading' should be replaced with 'ready'.

Related: are you really expecting users to submit their solutions each time they complete a challenge. If so, are those solutions accessible somewhere? It might be useful to be able to see how solutions differ, similar to what codewars does, but it might not be necessary, since each challenge has tests and therefore, the users will know whether their code is successful or not.

If the expectation is to submit your solutions, it might be helpful to include an additional explanation of how to access others' solutions.

2. In
   "An example of a good challenge to use as a template for now would be the Circle challenge. SpecificA ally, your new challenge should have:"

"SpecificA ally" should be changed to "Specifically"

WIP

Just a little detail I noticed:

https://github.com/Py-Lambdas/code-challenges/tree/master/200_digging_deeper/compact

Second-to-last-line of README:
"Finally, Feel free to reference the tests if you have any confusion about the expected behavior of the add function."

should be changed to:
Finally, Feel free to reference the tests if you have any confusion about the expected behavior of the compact function.

Minor issue noted in test_area function in test_circle.py:

• Definition noted in line 32 is circumference, not area (C = 2πr, A = πr^2)
• This actually won't be caught as of now because of the test on lines 34-35, since 2πr and πr^2 both equal 4π when r=2.
  Recommend changing this test case to:
  circle = Circle(3)
  self.assertEqual(circle.area, math.pi * 9)