Conversation
documentation assignment as well as 3 new .py files containing: the math engine, the image engine for the colour and knitting chart, and the app prototype on streamlit
created the report and filled out my progress on the project
julianwuth
left a comment
julianwuth
left a comment
There was a problem hiding this comment.
- Can the package be installed?
- Yes, it can.
- Is the vignette set up correctly?
- Yes, it is. However, there seem to be some problems with the rendering on GitHub.
- Did the unit tests run?
- Did they pass?
- Yes, they did, but they have low coverage.
- Anything else that comes to mind
- See in-line comments.
| @author: kasteivanauskaite | ||
| """ | ||
|
|
||
| from .example import add, calculate_mean |
There was a problem hiding this comment.
You'll probably want to delete this including the example.py file
There was a problem hiding this comment.
super thanks for the detailed comments!!!
|
|
||
| [project.optional-dependencies] | ||
| dev = [ | ||
| "pytest", |
There was a problem hiding this comment.
Perhaps add pytest-cov here, so you can check test coverage.
| elif panel_type == "Back Panel": | ||
| shaping = calculate_back_neck_shaping(total_sts, target_size, gauge_rows) | ||
| if use_shaping: | ||
| sweater_grid = apply_back_short_rows_to_grid(sweater_grid, shaping) |
There was a problem hiding this comment.
apply_back_short_rows_to_grid is not imported at the top, so this will lead to an error
| heart_sts = calculate_stitches(15.0, my_gauge_sts) | ||
| heart_rows = calculate_rows(15.0, my_gauge_rows) | ||
|
|
||
| giant_heart = scale_pattern_matrix(tiny_heart, heart_sts, heart_rows) |
There was a problem hiding this comment.
This should probably be scale_pattern_matrix_integer
LYang-uva
left a comment
LYang-uva
left a comment
There was a problem hiding this comment.
○ Can the package be installed? -yes
○ Is the vignette set up correctly? -- The short fix: add three or four code cells that import the engines, run a representative calculation, and print the output.
○ Did the unit tests set up with continuous integration run on GitHub? -yes
■ Did they pass? -yes
3 participants
report with all the details on the progress of this project + future implementations.
you can run the streamlit app from the terminal by pasting streamlit run src/knitting_pattern/app.py