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.

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

Update 03-create.md to include whitespace definition #679

Closed
wants to merge 1 commit into from

Conversation

kagross
Copy link

@kagross kagross commented Dec 26, 2017

Including a definition for whitespace the first time that it comes into play in the lesson could erase some confusion for students that don't know the word.

Please delete the text below before submitting your contribution.


Thanks for contributing! If this contribution is for instructor training, please send an email to checkout@carpentries.org with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.

Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact Kate Hertweck (k8hertweck@gmail.com).


Including a definition for whitespace the first time that it comes into play in the lesson could erase some confusion for students that don't know the word.
@gdevenyi
Copy link
Contributor

gdevenyi commented Jan 4, 2018

Thanks for the addition, can you maybe wrap this in a callout box?

@colinmorris
Copy link
Contributor

These changes are actually inside a callout box already (under the heading "Good names for files and directories"). I don't think they can be nested.

What if we replaced "whitespace" with "spaces"?

Practically speaking, I think it's exceedingly uncommon for someone to think to use tabs, newlines, or more exotic whitespace characters in filenames. I imagine anyone savvy enough to be aware of the existence of whitespace characters other than ' ' will probably also be able to intuit that they shouldn't go in filenames.

@colinmorris colinmorris added the type:discussion Discussion or feedback about the lesson label Jan 17, 2019
@gcapes
Copy link
Contributor

gcapes commented Jan 18, 2019

@colinmorris Nice neat suggestion and rationale.

@gdevenyi
Copy link
Contributor

Sorry, I'm not clear on the suggestion here, are we suggesting changes all mentions of "whitespace" to "spaces"?

@gcapes
Copy link
Contributor

gcapes commented Jan 22, 2019

Yep. Sacrificing a little bit of detail for simplicity.

@gdevenyi gdevenyi added status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR and removed type:discussion Discussion or feedback about the lesson labels Jan 22, 2019
@gcapes
Copy link
Contributor

gcapes commented Feb 14, 2019

@kagross Thanks for bringing this up. This has now been fixed/sidestepped in #915.

@gcapes gcapes closed this Feb 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants