Skip to content

Commit f4ebd49

Browse files
committed
Clarify wording of what lines need to be
Previously, the rule for blank lines technically did not cover empty lines. Clarify that leading and trailing whitespace are ignored on all lines.
1 parent 2445cbb commit f4ebd49

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
copyright = '2019--2024, EditorConfig Team'
2222
author = 'EditorConfig Team'
2323

24-
version = '0.16.0'
25-
release = '0.16.0'
24+
version = '0.16.1'
25+
release = '0.16.1'
2626

2727
# -- General configuration ---------------------------------------------------
2828

index.rst

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright (c) 2019--2020 EditorConfig Team
1+
.. Copyright (c) 2019--2024 EditorConfig Team
22
All rights reserved.
33
44
Redistribution and use in source and binary forms, with or without
@@ -73,15 +73,19 @@ EditorConfig organization.
7373
File Format
7474
===========
7575

76+
.. versionchanged:: 0.16.1
77+
7678
EditorConfig files are in an INI-like file format.
77-
In an EditorConfig file, all beginning whitespace on each line is considered
78-
irrelevant. Each line must be one of the following:
79+
To read an EditorConfig file, take one line at a time. For each line:
80+
81+
#. Strip all leading and trailing whitespace
82+
#. If the remaining text is not empty, process the text as specified for its
83+
type below.
84+
85+
The types of lines are:
7986

80-
- Blank: contains only whitespace characters.
8187
- Comment: starts with a ``;`` or a ``#``.
8288
- Section Header: starts with a ``[`` and ends with a ``]``.
83-
- May not use any non-whitespace characters outside of the surrounding
84-
brackets.
8589
- May contain any characters between the square brackets (e.g.,
8690
``[`` and ``]`` and even spaces and tabs are allowed).
8791
- Forward slashes (``/``) are used as path separators.

0 commit comments

Comments
 (0)