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

changing quotes to single quotes #1406

Merged
merged 2 commits into from
Mar 8, 2024
Merged

Conversation

GentleInfant
Copy link
Contributor

When dealing with special characters the lesson advises to use quotes, however single quotes is the safer option. For example

touch \$HOME
ls "$HOME" # lists the contents of the home directory
ls '$HOME' # lists the '$HOME' file

Please delete this line and 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 The Carpentries Team at team@carpentries.org.


When dealing with special characters the lesson advises to use quotes, however single quotes is the safer option. For example

```
touch \$HOME
ls "$HOME" # lists the contents of the home directory
ls '$HOME' # lists the '$HOME' file
```
@github-actions
Copy link

github-actions bot commented Jun 8, 2023

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/shell-novice/compare/md-outputs..md-outputs-PR-1406

The following changes were observed in the rendered markdown documents:

 02-filedir.md | 24 ++++++++++++------------
 03-create.md  |  3 ++-
 md5sum.txt    |  4 ++--
 3 files changed, 16 insertions(+), 15 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-03-08 23:32:49 +0000

episodes/03-create.md Outdated Show resolved Hide resolved
@bkmgit
Copy link
Contributor

bkmgit commented Jul 23, 2023

Thanks. As per , this is good. Due to time constraints, it is unlikely this can be discussed. Perhaps adding a link to the documentation is helpful?

Co-authored-by: Benson Muite <bkmgit@users.noreply.github.com>
@ErinBecker
Copy link
Contributor

Thanks @GentleInfant for the addition and @bkmgit for adding a link to the documentation.

@ErinBecker ErinBecker merged commit 5507316 into swcarpentry:main Mar 8, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Mar 8, 2024
github-actions bot pushed a commit that referenced this pull request Mar 8, 2024
Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
github-actions bot pushed a commit that referenced this pull request Mar 8, 2024
Auto-generated via {sandpaper}
Source  : e8dcf23
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-03-08 23:34:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
github-actions bot pushed a commit that referenced this pull request Mar 12, 2024
Auto-generated via {sandpaper}
Source  : e8dcf23
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-03-08 23:34:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
github-actions bot pushed a commit that referenced this pull request Mar 19, 2024
Auto-generated via {sandpaper}
Source  : e8dcf23
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-03-08 23:34:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
github-actions bot pushed a commit that referenced this pull request Mar 26, 2024
Auto-generated via {sandpaper}
Source  : e8dcf23
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-03-08 23:34:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
github-actions bot pushed a commit that referenced this pull request Apr 2, 2024
Auto-generated via {sandpaper}
Source  : e8dcf23
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-03-08 23:34:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
github-actions bot pushed a commit that referenced this pull request Apr 9, 2024
Auto-generated via {sandpaper}
Source  : e8dcf23
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-03-08 23:34:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 5507316
Branch  : main
Author  : Erin Becker <erinstellabecker@gmail.com>
Time    : 2024-03-08 23:33:25 +0000
Message : Merge pull request #1406 from GentleInfant/patch-1

changing quotes to single quotes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants