Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Code comments, docstrings, orangization, formatting, naming #8

Closed
blahosyl opened this issue Apr 7, 2024 · 0 comments
Closed

Code comments, docstrings, orangization, formatting, naming #8

blahosyl opened this issue Apr 7, 2024 · 0 comments
Assignees
@blahosyl
Labels
documentation Improvements or additions to documentation ongoing Tasks performed throughout development

Comments

@blahosyl
Copy link
Owner

blahosyl commented Apr 7, 2024

No description provided.

@blahosyl blahosyl added documentation Improvements or additions to documentation ongoing Tasks performed throughout development labels Apr 7, 2024
@blahosyl blahosyl self-assigned this Apr 7, 2024
blahosyl added a commit that referenced this issue Apr 11, 2024
@blahosyl
add code comments #8 #16 #14
2babe14
blahosyl added a commit that referenced this issue Apr 11, 2024
@blahosyl
update code comments + print statements #8
f0d849b
blahosyl added a commit that referenced this issue Apr 13, 2024
@blahosyl
update code comments #8
a034692
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
correct docstring #8 #31
8759e45
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
add code comments #8
6f9b4ee
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
rename print_string() to improve readability #8
caa68b3 
The function `print_string()` had the same name as the variable `print_string` inside it, so the function is renamed to `print_formatted()` to avoid confusion and improve the human readability of the code
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
update code comments and formatting #8
bead437
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
add code credits #4 #8
889d710
@blahosyl blahosyl moved this from Todo to Ongoing/Blocked in Dinner Party Planner Apr 15, 2024
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
rename add_ingredients() #8
5a28bb2 
The new name `unify_ingredients()` reflects the function's purpose better and improves human readability of the code
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
comment out print() for testing/assessment #8 #28
6905daf
blahosyl added a commit that referenced this issue Apr 16, 2024
@blahosyl
refactor: print_shopping_list_block() unified #8
3bc1c83
blahosyl added a commit that referenced this issue Apr 16, 2024
@blahosyl
add code comment #8
46dd9b6
blahosyl added a commit that referenced this issue Apr 16, 2024
@blahosyl
update code comments #8 #39
ebe8ec6
blahosyl added a commit that referenced this issue Apr 16, 2024
@blahosyl
fix indentation after validation #8 #39
dfd93f0
blahosyl added a commit that referenced this issue Apr 16, 2024
@blahosyl
fix placement of code comment #8
0a25c74
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
fix indentation #8
d670ed4
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
update code comments, indentation #8 #20
0f0ec65
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
rename Y/N validator function #8
19096a4 
This improves consistency and legibility
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
rename range validator function #8
6b6a807 
Previous name was too long, and `number` in it was superfluous. This improves consistency and legibility
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
unify, goodbye message, move it to constant #8
cb62b14
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
improve code comments #8
7a33b43
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
improve code comments #8
b79299f
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
separate parse string function #8
9c6d318 
Made into a separate function from `print_formatted`.
blahosyl added a commit that referenced this issue Apr 17, 2024
@blahosyl
add vertical space for readability #8
af31333
@blahosyl blahosyl changed the title Code comments, docstrings and formatting Code comments, docstrings, orangization, formatting, naming Apr 18, 2024
blahosyl added a commit that referenced this issue Apr 18, 2024
@blahosyl
make param name in validators more specific #8
e045eb1 
This improves human legibility by using a more specific name
blahosyl added a commit that referenced this issue Apr 18, 2024
@blahosyl
update docstrings in planner #8 #44
bb87756
blahosyl added a commit that referenced this issue Apr 18, 2024
@blahosyl
update docstrings in utilities #8 #44
3a189ea
blahosyl added a commit that referenced this issue Apr 18, 2024
@blahosyl
update code comments & docstrings #8 #44
c6b51e2
blahosyl added a commit that referenced this issue Apr 18, 2024
@blahosyl
update code comments #8 #11
5c9cd42
blahosyl added a commit that referenced this issue Apr 18, 2024
@blahosyl
update code comments #8 #11
522f915
@github-project-automation github-project-automation bot moved this from Ongoing/Blocked to Done in Dinner Party Planner Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blahosyl blahosyl

Labels
documentation Improvements or additions to documentation ongoing Tasks performed throughout development
Projects
Dinner Party Planner
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@blahosyl