Skip to content

Commit 04bbc3a

Browse files
committed
docs: discuss cog in the contributing docs
1 parent c181b93 commit 04bbc3a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/contributing.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,25 @@ Many people love auto-formatting with `black`_ or `ruff`_, but I would prefer
242242
not to on coverage.py.
243243

244244

245+
Cog
246+
---
247+
248+
Parts of the documentation and GitHub actions are kept up-to-date with `cog`_.
249+
There are checks to make sure that files are correct and not being incorrectly
250+
edited.
251+
252+
If a check fails, it will show you what command to run to update the files.
253+
If you edit parts of a file that should be generated, you will see a message
254+
like::
255+
256+
Output has been edited! Delete old checksum to unprotect.
257+
258+
Probably you should revert the edits and run the command to generate the
259+
output. The top of the file you edited will have instructions.
260+
261+
.. _cog: https://cog.readthedocs.io
262+
263+
245264
Continuous integration
246265
----------------------
247266

0 commit comments

Comments
 (0)