Skip to content

Commit

Permalink
Add spelling_language property (editorconfig#41)
Browse files Browse the repository at this point in the history
* Add spelling_language property

To specify the natural language for which spelling should be checked.

* Add .readthedocs.yaml

Now required per
readthedocs/readthedocs.org#4668
  • Loading branch information
cxw42 authored Feb 2, 2024
1 parent e02645d commit 0b3ffbd
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
6 changes: 5 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,8 @@ max_line_length = 78
indent_size = 4
indent_style = space
end_of_line = lf
max_line_length = 78
max_line_length = 78

[*.{yaml,yml}]
indent_size = 2
indent_style = space
9 changes: 9 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.12"

sphinx:
configuration: conf.py
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--2020, EditorConfig Team'
author = 'EditorConfig Team'

version = '0.15.1'
release = '0.15.1'
version = '0.16.0'
release = '0.16.0'

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

Expand Down
13 changes: 12 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ files take precedence.
Supported Pairs
===============

.. versionchanged:: 0.15.1
.. versionchanged:: 0.16

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 @@ -224,6 +224,15 @@ and the supported values associated with them:
* - ``charset``
- Set to ``latin1``, ``utf-8``, ``utf-8-bom``, ``utf-16be`` or ``utf-16le`` to
control the character set. Use of ``utf-8-bom`` is discouraged.
* - ``spelling_language``
- Sets the natural language that should be used for spell checking.
Only one language can be specified. There is no default value.

The format is ``ss`` or ``ss-TT``, where ``ss`` is an `ISO 639`_
language code and ``TT`` is an `ISO 3166`_ territory identifier.

**Note:** This property does **not** specify the charset to be used.
The charset is in separate property ``charset``.
* - ``trim_trailing_whitespace``
- Set to ``true`` to remove all whitespace characters preceding newline
characters in the file and ``false`` to ensure it doesn't.
Expand Down Expand Up @@ -277,6 +286,8 @@ numbers. Those version numbers are independent of the version number of
this specification.

.. _core-tests repository: https://github.com/editorconfig/editorconfig-core-test
.. _ISO 639: https://en.wikipedia.org/wiki/ISO_639
.. _ISO 3166: https://en.wikipedia.org/wiki/ISO_3166
.. _Python configparser Library: https://docs.python.org/3/library/configparser.html
.. _Plugin Guidelines: https://github.com/editorconfig/editorconfig/wiki/Plugin-Guidelines
.. _plugin-tests repository: https://github.com/editorconfig/editorconfig-plugin-tests
Expand Down

0 comments on commit 0b3ffbd

Please sign in to comment.