carpentries-incubator / carpentries-incubator/swc-ext-python
(Suggestion) Refactor the refactor lesson
Open
enhancement
help wanted
- Dominant language
- Python
- Stars
- 2
- Forks
- 5
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
I think the refactor lesson could be broken up into more discrete sections. I think this order might be best.
- break into functions (true refactor)
- `if __name__=="__main__": main() `
- importing
- documentation
While it is probably best practice to write doc strings immediately when writing a function, but forces us to spend a lot of time typing with the learners instead of getting to new material. I think that making them less formal will help with this. We can always display what a proper set of docstrings looks like using a fully fledged Python package like numpy or pandas.
Contributor guide
Assessment
This issue has not been assessed yet.