Correct language tags on five non-YAML code examples - #45907
Open
SurefireStudios wants to merge 1 commit into
Open
SurefireStudios wants to merge 1 commit into
SurefireStudios wants to merge 1 commit into
Conversation
Five blocks in "Remove access to public registries" are tagged `yaml copy` but contain other formats: two yarn.lock excerpts, a pip.conf INI section, a Pipfile TOML section, and a pyproject.toml TOML section. None parse as YAML, and each is highlighted with the wrong grammar. Retagged as `text`, which is already used elsewhere in content/ for formats without a dedicated tag. The seven genuine dependabot.yml examples in this article are unchanged.
Contributor
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
github-actions
Bot
added
the
triage
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why:
Closes:
No existing issue — found by parsing every fenced
yamlblock incontent/.Five code blocks in "Remove access to public registries" are tagged
yaml copy, but none of them contain YAML. Each is a different package manager's own config format, so the syntax highlighter applies the wrong grammar:yarn.locklockfilepip.conf(INI)Pipfile(TOML)pyproject.toml(TOML)The last two are self-evident from the surrounding prose, which names the file: "Add the private registry URL to the
[[source]]section of thePipfilefile" and "Add the private registry url to the[[tool.poetry.source]]section of thepyproject.tomlfile".What's being changed (if available, include any code snippets, screenshots, or gifs):
Retagged those five blocks from
yaml copytotext copy.I chose
textovertoml/inideliberately:textis already used ~400 times acrosscontent/, whiletomlandiniappear nowhere, so this follows existing house style rather than introducing new tags. Happy to switch totomlfor the Pipfile and pyproject.toml blocks if you'd prefer the more precise grammar.The
copyattribute is preserved on every block. The seven genuinedependabot.ymlexamples in this article are untouched, and I confirmed they all still parse as YAML.No prose, content, or behavior changes.
Check off the following: