Skip to content

Commit

Permalink
Clarify wording of what lines need to be
Browse files Browse the repository at this point in the history
Previously, the rule for blank lines technically did not cover
empty lines.  Clarify that leading and trailing whitespace are ignored
on all lines.
  • Loading branch information
cxw42 committed Sep 15, 2024
1 parent 2445cbb commit f4ebd49
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
4 changes: 2 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
copyright = '2019--2024, EditorConfig Team'
author = 'EditorConfig Team'

version = '0.16.0'
release = '0.16.0'
version = '0.16.1'
release = '0.16.1'

# -- General configuration ---------------------------------------------------

Expand Down
16 changes: 10 additions & 6 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright (c) 2019--2020 EditorConfig Team
.. Copyright (c) 2019--2024 EditorConfig Team
All rights reserved.
Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -73,15 +73,19 @@ EditorConfig organization.
File Format
===========

.. versionchanged:: 0.16.1

EditorConfig files are in an INI-like file format.
In an EditorConfig file, all beginning whitespace on each line is considered
irrelevant. Each line must be one of the following:
To read an EditorConfig file, take one line at a time. For each line:

#. Strip all leading and trailing whitespace
#. If the remaining text is not empty, process the text as specified for its
type below.

The types of lines are:

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

0 comments on commit f4ebd49

Please sign in to comment.