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

README.md: Mention link to supported Ruby versions for GitHub-hosted runners #651

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

stdedos
Copy link
Contributor

@stdedos stdedos commented Oct 2, 2024

Fixes #650

Signed-off-by: Stavros Ntentos 133706+stdedos@users.noreply.github.com

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
…d runners

Fixes ruby#650

Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com>
@eregon eregon force-pushed the docs/README.md/mention-toolcache branch from e4de9b3 to 28f3626 Compare October 2, 2024 20:25
Copy link
Member

@eregon eregon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@eregon eregon merged commit 79c01b8 into ruby:master Oct 2, 2024
25 checks passed
@stdedos
Copy link
Contributor Author

stdedos commented Oct 2, 2024

Thanks

... I would appreciate a heads up before merging 😕

I won't try to source an "very authoritative source", but [here]() urls can be a very bad thing to do from a11y point-of-view, e.g. https://heyoka.medium.com/dont-use-click-here-f32f445d1021#a1f6

@eregon
Copy link
Member

eregon commented Oct 2, 2024

The entire README has no URLs as plain text, because that takes a very large amount of space and IMO hurts readability. So I did the obvious fix, keeping your sentence as-is, and I undid the unrelated whitespace changes (the spaces are intentional and have an effect).

Feel free to propose a better wording or linking.

@stdedos
Copy link
Contributor Author

stdedos commented Oct 2, 2024

and I undid the unrelated whitespace changes (the spaces are intentional and have an effect).

Those changes were unintentional from my part. All of my smart editors are configured to prune trailing whitespace.

What effect do they have on Github Commonmark? 😕

Note that https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#paragraphs mentions

You can create a new paragraph by leaving a blank line between lines of text.

and there is a testament of the GhFM-feature on the internet: https://stackoverflow.com/a/24576087/2309247

It is mentioned in https://github.github.com/gfm/#hard-line-break, https://docs.gitlab.com/ee/user/markdown.html#newlines for ways to force a line break (including the N>1 trailing spaces) - but even if https://stackoverflow.com/a/24576087/2309247 is not mentioned, it still happens.
See this comment for example. 😅

@eregon
Copy link
Member

eregon commented Oct 2, 2024

It forces a newline, without extra vertical spacing, as e.g. in https://github.com/ruby/setup-ruby?tab=readme-ov-file#caching-bundle-install-automatically
It doesn't affect comments but it does affect the README.

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

Successfully merging this pull request may close these issues.

No "available interpreter-os association" is visible on the action?
2 participants