Skip to content

clarification on -C option#1122

Merged
martinosorb merged 2 commits into
swcarpentry:mainfrom
gjduine:email-clarification-gjduine
May 10, 2026
Merged

clarification on -C option#1122
martinosorb merged 2 commits into
swcarpentry:mainfrom
gjduine:email-clarification-gjduine

Conversation

@gjduine
Copy link
Copy Markdown
Contributor

@gjduine gjduine commented May 1, 2026

Closes #1129

For novice users, the addition of an e-mail address is unclear, so some additional information would be helpful

Full issue here:
#1121

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

🆗 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.

@martinosorb
Copy link
Copy Markdown
Contributor

Thank you for this. It looks good in principle, but I find it a little dry: for example it's not clear to me what "hostnames, or no comment at all" means. Maybe we can make it into a friendlier sentence? Something like
"In the command above, the `-C- flag is used to label the SSH key with the owner's email address. It's good practice to use the same email associated to your GitHub account, but it does not have to be, and will not be used to validate the access. You can also decide not to add any label."

How does that sound?

@gjduine
Copy link
Copy Markdown
Contributor Author

gjduine commented May 5, 2026

yes that sounds much better, in fact. Thank you. How does it work from here? Do I change the sentence?

@martinosorb
Copy link
Copy Markdown
Contributor

You can add another commit to the branch where you did the first change, and it will automatically be updated in the pull request. Thanks!

@martinosorb martinosorb merged commit 8343d1a into swcarpentry:main May 10, 2026
2 checks passed
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.

2 participants