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

Supported properties: Clarify semantics of "root" #60

Merged
merged 2 commits into from
Sep 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ files take precedence.
Supported Pairs
===============

.. versionchanged:: 0.16
.. versionchanged:: 0.17.1

EditorConfig file sections contain key-value pairs separated by an
equal sign (``=``). With the exception of the ``root`` key, all pairs MUST be
Expand Down Expand Up @@ -267,9 +267,9 @@ and the supported values associated with them:
- Set to ``true`` ensure file ends with a newline when saving and ``false``
to ensure it doesn't.
* - ``root``
- Must be specified in the preamble. Set to ``true`` to stop the
``.editorconfig`` file search on the current file. The value is case
insensitive.
- Must be specified in the preamble. Set to ``true`` to tell the core
not to check any higher directory for EditorConfig settings for on the
current filename. The value is case-insensitive.

For any pair, a value of ``unset`` removes the effect of that
pair, even if it has been set before. For example, add ``indent_size =
Expand Down