From 0a83d79fc928701474d2995bb843e36f3a5481e3 Mon Sep 17 00:00:00 2001
From: Evan Chen <evan@evanchen.cc>
Date: Tue, 2 Jan 2024 15:55:35 -0800
Subject: [PATCH] doc: Specify .codespellrc is INI formatted

Closes #3229
---
 README.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.rst b/README.rst
index ee28e0a3e3..e229b36dfe 100644
--- a/README.rst
+++ b/README.rst
@@ -152,6 +152,11 @@ be specified in this file (without the preceding dashes), for example:
     count =
     quiet-level = 3
 
+The ``.codespellrc`` file is an `INI file <https://en.wikipedia.org/wiki/INI_file>`_,
+which is read using Python's
+`configparser <https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_.
+For example, comments are possible using ``;`` or ``#`` as the first character.
+
 Codespell will also check in the current directory for a ``pyproject.toml``
 (or a path can be specified via ``--toml <filename>``) file, and the
 ``[tool.codespell]`` entry will be used, but only if the tomli_ package