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

style-guide: recommend hyphen over en dash and em dash #15407

Merged
merged 3 commits into from
Jan 4, 2025

Conversation

cyqsimon
Copy link
Collaborator

@cyqsimon cyqsimon commented Jan 1, 2025

Continuing discussion in #15384 (comment).

@spageektti and I are in favour of hyphens in lieu of exceptional circumstances. I'd like to hear the opinions of other maintainers.

@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Jan 1, 2025
@cyqsimon
Copy link
Collaborator Author

cyqsimon commented Jan 1, 2025

I did a quick search over the current English pages. It seems like there were only four instances of en dashes or em dashes.

Search

Notably, the one in bundletool.md seems to be an example of "author not knowing/noticing the subtle difference leading to a mistake".

Usage seems to be more common in Cyrillic languages, but I'm not sure whether that's a tendency of the language or of the author.

contributing-guides/style-guide.md Outdated Show resolved Hide resolved
@sebastiaanspeck
Copy link
Member

I did a quick search over the current English pages. It seems like there were only four instances of en dashes or em dashes.

Search

Notably, the one in bundletool.md seems to be an example of "author not knowing/noticing the subtle difference leading to a mistake".

Usage seems to be more common in Cyrillic languages, but I'm not sure whether that's a tendency of the language or of the author.

I opened a PR for bundletool.md: #15410

@sebastiaanspeck sebastiaanspeck changed the title STYLE GUIDE: recommend hyphen to en dash and em dash style-guide: recommend hyphen over en dash and em dash Jan 1, 2025
@github-actions github-actions bot added the review needed Prioritized PRs marked for reviews from maintainers. label Jan 1, 2025
@sebastiaanspeck
Copy link
Member

@kbdharun I now see we do not check if a PR without any assigned reviewers is still in "Draft". This is why the labeler assigned "review needed" just yet. I would also let the labeler action run when we change a PR from "draft" to "ready for review".

Co-authored-by: Wiktor Perskawiec <git@spageektti.cc>
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
@cyqsimon cyqsimon marked this pull request as ready for review January 2, 2025 04:31
@cyqsimon cyqsimon requested review from sbrl and kbdharun as code owners January 2, 2025 04:31
Copy link
Member

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the nice addition.

contributing-guides/style-guide.md Outdated Show resolved Hide resolved
@spageektti spageektti self-requested a review January 3, 2025 17:40
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
@sebastiaanspeck sebastiaanspeck merged commit 4b6600a into tldr-pages:main Jan 4, 2025
4 checks passed
@cyqsimon cyqsimon deleted the dash-style branch January 5, 2025 04:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues/PRs modifying the documentation. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants