removed class and spellchecked #71
Conversation
|
This is great! I am going to make some minor revisions before accepting, but I want to let you know that the overall direction is wonderful. thank you for planning to split contiributions over multiple prs. |
|
No worries! Sorry it's so scruffy. Haven't figured out how to build it locally to preview the webpages yet. I'll wait for revisions on this one before building the next PR |
|
@callumrollo the Setup page of the Lesson Example includes instructions for configuring your system for local builds. If you run into trouble following those, feel free to reach out on The Carpentries Slack or by email (tobyhodges at carpentries dot org). |
|
Thanks @tobyhodges got Ruby installed and serving. Will check webpages renders before future PRs |
|
After rendering the page locally, I've caught some more typos/phrasing and brought the formatting more in line with other carpentries lessons. Hopefully less revisions for you @brownsarahm My edits end at section Command Line Tools. Further work for future PRs. |
| folder a module, but by adding code, we can make our package easier to use. | ||
| The init file is the map that tells python what our package looks like. It is | ||
| also what tells Python a directory is a module. An empty init file marks a | ||
| directory as a module. By adding import code, we can make our package easier to use. |
There was a problem hiding this comment.
Does it make sense to demonstrate what init does by trying to use it without? and then add it and use with?
There was a problem hiding this comment.
This would be take some explaining. I'm pretty sure Python 3.3 + can import from folders without an init. The init file only really becomes essential once we make a package and ship to PyPI. In this case it may be simpler to just always include the init.
There was a problem hiding this comment.
I was thinking an example of how imports can change with the init, like, reducing the levels of the imports eg how you can use the package.module once you have init or even package.function() if the depending on the contents of the init file? In pilots of this workshop (and in working with students in research ) they tend to struggle with what to put in the init file, other than pattern matching what's already there.
Corrections up to Python Modules Co-authored-by: Sarah Brown <[email protected]>
Typos caught by brownsarahm Co-authored-by: Sarah Brown <[email protected]>
|
Other than the discussion about init I hope I've addressed all the issues. Sorry for making such a big PR! I'll work in smaller steps next time |
Co-authored-by: Sarah Brown <[email protected]>
|
Thanks, I've updated to numpy docstrings. Should be ready to roll |
|
🎉 thanks so much! |
Closes #65
Summary of changes:
Still quite a bit of work to do on this lesson, but I'll try to break further work upit into multiple PRs.