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

Inconsistent text formatting #35361

Open
1 task done
akordowski opened this issue Nov 20, 2024 · 2 comments
Open
1 task done

Inconsistent text formatting #35361

akordowski opened this issue Nov 20, 2024 · 2 comments
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Comments

@akordowski
Copy link
Contributor

akordowski commented Nov 20, 2024

Code of Conduct

What article on docs.github.com is affected?

Multiple articles.

What part(s) of the article would you like to see updated?

I noticed that there is a inconsistent text formatting regarding the text **Keyword**: Text (559 results) and **Keyword:** Text (331 results).

I don't know if there are any conventions regarding using a colon with a bold text, inside or outside. But from the formatting/style perspective the **Keyword:** Text seams to make more sense, as the keyword and the colon are a unit in the text.

EDIT:
There is also a inconsistent usage of the dash character. There are usages of Text—Text and Text — Text, even in the same article.

Additional information

I could provide a PR for this issue.

@akordowski akordowski added the content This issue or pull request belongs to the Docs Content team label Nov 20, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 20, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 20, 2024
@nguyenalex836
Copy link
Contributor

@akordowski Hello! 👋 Thank you for opening this issue!

But from the formatting/style perspective the Keyword: Text seams to make more sense, as the keyword and the colon are a unit in the text.

As I couldn't find anything in our style guide referencing guidelines for this, I'm inclined to agree with you 💛

I'll get this up for review just so we can get a second opinion on this, as well as the inconsistency between usage of Text—Text and Text — Text

@subatoi
Copy link
Contributor

subatoi commented Nov 22, 2024

Hi @akordowski 👋

You're correct that this isn't consistent 👍

I don't know if there are any conventions regarding using a colon with a bold text, inside or outside. But from the formatting/style perspective the Keyword: Text seams to make more sense, as the keyword and the colon are a unit in the text.

The main reason we use bold is for emphasis (see https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide#emphasis). Generally speaking, as long as we're consistent, it shouldn't matter which we use, and I agree with you that **Keyword**: Text makes more sense (and is the most common one as of now, anyway).

It's possible there are some minor edge cases which may require one or the other. As such, if you're interested in making this contribution, if possible, I'd recommend splitting it into multiple PRs so it's easier for us to review.

There is also a inconsistent usage of the dash — character. There are usages of Text—Text and Text — Text, even in the same article.

I agree with you here, too, but if you're interested in a contribution for this, as well, then I'd kindly request that you open a new issue so we can separate the work.

Thank you again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

3 participants