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

Labels with periods do not render #21207

Closed
1 task done
aspaninks opened this issue Oct 8, 2022 · 5 comments · Fixed by #21294
Closed
1 task done

Labels with periods do not render #21207

aspaninks opened this issue Oct 8, 2022 · 5 comments · Fixed by #21294
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@aspaninks
Copy link

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#labels

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

Article states:

When referencing the URL of a label in Markdown, the label is automatically rendered.

My repo has labels with a period . in them, e.g.: Thing.Abc, Thing.Xyz, etc.
These labels do not render automatically via the described method.
I also tried an escape character \. and a unicode notation .

Expected outcome:
Update documentation to mention labels should not contain .

Additional information

See #18704, it contains a good explanation and example, which I used to confirm it was not user-error. I was able to get non-period labels to render successfully.

@aspaninks aspaninks added the content This issue or pull request belongs to the Docs Content team label Oct 8, 2022
@welcome
Copy link

welcome bot commented Oct 8, 2022

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 8, 2022
@Atisitnaknawa

This comment was marked as spam.

@cmwilson21 cmwilson21 added waiting for review Issue/PR is waiting for a writer's review get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Oct 10, 2022
@cmwilson21
Copy link
Contributor

@aspaninks Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@sabrowning1
Copy link
Contributor

Hi @aspaninks, thanks for opening this issue! 💛 This would be a helpful addition to the docs. You or anyone others are welcome to open a PR with this change 👍🏼

@sabrowning1 sabrowning1 added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Oct 10, 2022
@ujjwal-shekhar
Copy link
Contributor

Hi can I work on this

ujjwal-shekhar added a commit to ujjwal-shekhar/docs-1 that referenced this issue Oct 12, 2022
Updated the documentation to account for issue : github#21207
@ujjwal-shekhar ujjwal-shekhar mentioned this issue Oct 12, 2022
2 tasks
sabrowning1 added a commit that referenced this issue Oct 12, 2022
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 get started Content related to "Getting Started" doc set help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants
@aspaninks @cmwilson21 @ujjwal-shekhar @Atisitnaknawa @sabrowning1 and others