📝 Add a change note for PR #961

aio-libs · Nov 23, 2023 · baade0c · baade0c
1 parent d6d491d
commit baade0c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGES/961.contrib.rst b/CHANGES/961.contrib.rst
@@ -0,0 +1,15 @@
+Coverage collection has been implemented for the Cython modules
+-- by :user:`webknjaz`.
+
+It will also be reported to Codecov from any non-release CI jobs.
+
+To measure coverage in a development environment, *yarl* can be
+installed in editable mode, which requires an environment variable
+``YARL_CYTHON_TRACING=1`` to be set:
+
+.. code-block:: console
+
+    $ YARL_CYTHON_TRACING=1 python -Im pip install -e .
+
+Editable install produces C-files required for the Cython coverage
+plugin to map the measurements back to the PYX-files.
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -1,10 +1,12 @@
 Bluesky
 Bugfixes
 Changelog
+Codecov
 Cython
 GPG
 IPv
 PRs
+PYX
 Towncrier
 Twitter
 UTF