Skip to content

Conversation

@ramGranell
Copy link
Contributor

If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.

Closes #246

Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.

I have modified the file learners/reference.md to harmonise the format as it was requested in the ticket. In addition I performed small modifications. The changes I performed can be summarised here:

  1. After each command is defined in the references, there is always "-" symbol
  2. All the verbs after the command/wildcard are in infinitive and not third-person
  3. When flags are explained, I put always the command before the flag being consistent with the first "ls" example
  4. Vertical bar character is not a flag of grep command and I added a separated command. I added also a small example using previous commands
  5. I added a flag for the sort command as its normal behaviour is sorting using alphabetic characters

If any relevant discussions have taken place elsewhere, please provide links to these.

For more guidance on how to contribute changes to a Carpentries project, please review the Contributing Guide and Code of Conduct.

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.

@github-actions
Copy link

github-actions bot commented Aug 7, 2025

🆗 Pre-flight checks passed 😃

This pull request has been checked and contains no modified workflow files, spoofing, or invalid commits.

It should be safe to Approve and Run the workflows that need maintainer approval.

ramGranell and others added 2 commits August 12, 2025 22:45
Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>
Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>
@kaitlinnewson
Copy link
Member

Hi @ramGranell, apologies for the delay! Just one more comment on this then I think we are ready to merge - thanks!

@ramGranell
Copy link
Contributor Author

Hi @ramGranell, apologies for the delay! Just one more comment on this then I think we are ready to merge - thanks!

Hi @kaitlinnewson do not worry, you are working in this repo when you have time.

@kaitlinnewson kaitlinnewson merged commit ebe4937 into LibraryCarpentry:main Sep 17, 2025
1 check passed
@kaitlinnewson
Copy link
Member

Merged, thanks @ramGranell!

github-actions bot pushed a commit that referenced this pull request Sep 17, 2025
Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Sep 17, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Sep 17, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Sep 23, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Sep 30, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Oct 7, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Oct 14, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Oct 21, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Oct 28, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Nov 4, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
github-actions bot pushed a commit that referenced this pull request Nov 11, 2025
Auto-generated via `{sandpaper}`
Source  : 763e5fb
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-17 16:13:21 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : ebe4937
Branch  : main
Author  : ramGranell <39826987+ramGranell@users.noreply.github.com>
Time    : 2025-09-17 16:12:24 +0000
Message : Format ref page#246 (#287)

* Changing format and some examples in the the reference file
* Adding new hyphen for file reference.md
* Remove third-person s in all lines
* Small typo in file file reference.md
* Update learners/reference.md

Co-authored-by: Kaitlin Newson <kaitlin.newson@gmail.com>

* Update learners/reference.md
* Update reference.md
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.

Consistent formatting of the reference page

2 participants