docs(editorconfig): align documented YAML indent size with actual configs - #87
Merged
Conversation
…figs The guide showed `indent_size = 2` for YAML in three example .editorconfig snippets while every .editorconfig in the organization uses 4, so readers copying the guide produced files that conflict with the repositories they were meant to match. Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
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
1 participant
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.
Summary
.editorconfigexamples in the guide documentedindent_size = 2for YAML while every.editorconfigin the organization sets 4, so the guide contradicted the repositories it describes.cicd.rst,environment.rsttwice), including the explanatory comment next to one of them. Documentation follows reality here — the reverse would reformat every YAML file in the organization.Test plan
rg -n 'indent_size' rst/reports 4 for every occurrence