rafaelbroseghini/communipy

:books: :pencil2: Python, Learning, Sharing, Contributing :computer: :snake:

• 👋 Hi, I’m Rafa!
• 📫 How to reach me -> Linkedin

communipy's Issues

Add project ideas

Add project ideas following guideline on TEMPLATE.md within Project Ideas folder.

Inconsistent and Improper Indents. add Guidelines to CONTRIBUTING.md

CommuniPy/Practice Problems/03-Dictionaries/Beginner/test_dicts.py

Line 10 in e805766

print("\n.Passed task 1 with no errors!")

Extra space causing test case to fail.

CommuniPy/Practice Problems/05-Math/01-Beginner/math.py

Lines 7 to 9 in e805766

	"""
	Given a number, return if it is even or odd.
	"""

Improper indents make files look inconsistent.

Many pushes have these naive mistakes which make practice files look weird. Please add guidelines to CONTRIBUTING.md about submitting PEP8 compliant code or better, define standards by giving a template for additions.

Write problems for Sets

Follow the guidelines in Folder 'Strings'

Syntactical Problems in old TestCases.

CommuniPy/Practice Problems/01-Strings/Beginner/test_strings.py

Line 5 in e805766

class Tester(unittest.TestCase):

Instead of naming them Testers these should be named as
eg. StringsBeginnerTestCase.

CommuniPy/Practice Problems/01-Strings/Beginner/test_strings.py

Line 11 in e805766

print("\n.Passed task 1 with no errors!")

Change the print statements to

print("\n.Passed 1. reverse_string with no errors!")

write tests for test_math.py

Write tests.

Formatting of practice files.

I have two suggestions regarding the Formatting of the practice files.

1. I found the header String to be a bit non-standard.

__ author __ is assigned the author name mostly.
and the date and filename can be generated if needed by __ file __ and os.path.getmtime(__ file __).
If needed then other meta information can be given as __ excercise __.

__author__="John Doe"
__excercise__="Strings" # optional
__date__ ="12/12/1234"  # optional

2. I suggest giving the problem statement as a docstring to a function as it makes it much less ambiguous that where should a particular question's answer should be given.
   Take this for instance-

"""some question"""

def taskx():
    pass

"""some other question"""

def tasky():
    pass

def taskx():
    """some question"""
    pass

def tasky():
    """some other question"""
    pass

The latter looks more neat to me.

Changes in .gitignore?

*.pyc should also be added else it will ignore the directory __ pycache __ but not the *.pyc files under it which is making it add __ pycache __ again and again.

Write problems for Dicts

Follow the guidelines from the Folder 'Strings'

Ambiguity in math problems and module.

math problems file is named math.py, if someone tries to import math in it, it will import itself.

CommuniPy/Practice Problems/05-Math/01-Beginner/math.py

Lines 3 to 4 in e805766

	# For purposes of practicing do not import math.
	# Assume pi = 3.14

Instead of resolving the name problem comment is given that assume values instead of importing?

it should be renamed to maths.py

CommuniPy/Practice Problems/05-Math/01-Beginner/math.py

Lines 12 to 17 in e805766

	def sum_them_all(number):
	"""
	Given a number, return the sum of all digits from
	zero to the number (inclusive).
	"""
	pass

Problem doesn't state what to do when number is negative, neither it says that number will only be positive.
Give proper conditions for input.

CommuniPy/Practice Problems/05-Math/01-Beginner/math.py

Lines 6 to 10 in e805766

	def even_or_odd(number):
	"""
	Given a number, return if it is even or odd.
	"""
	pass

Tell explicitly what to return eg.

"""
        Given a number, return string 'even' if it is even or 'odd' if it is odd.
"""

Write tests for test_lists.py

Follow the template in test_strings.py for test cases.

Copy exercises in strings old and apply new exercise format

Follow guidelines in reverse_string.py

Add Dicts folder

Add dicts.py and test_dicts.py with exercises and test cases respectively.

Add a .gititnore and add the line */__pycache__/* to the file.

I will take care of this and submit a PR.