From e52d616a065da649494f37112cadfde0c646a0b9 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 15 Jan 2022 17:16:46 -0500 Subject: build: provide hints about how to fix cog-check quality failures. --- doc/cmd.rst | 4 ++++ doc/dbschema.rst | 4 ++++ 2 files changed, 8 insertions(+) (limited to 'doc') diff --git a/doc/cmd.rst b/doc/cmd.rst index ed86e28a..a26aa8ac 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1,6 +1,10 @@ .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt +.. This file is meant to be processed with cog to insert the latest command + help into the docs. If it's out of date, the quality checks will fail. + Running "make prebuild" will bring it up to date. + .. [[[cog import contextlib import io diff --git a/doc/dbschema.rst b/doc/dbschema.rst index c6f3395e..9b5ee883 100644 --- a/doc/dbschema.rst +++ b/doc/dbschema.rst @@ -1,6 +1,10 @@ .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt +.. This file is meant to be processed with cog to insert the latest database + schema into the docs. If it's out of date, the quality checks will fail. + Running "make prebuild" will bring it up to date. + .. _dbschema: =========================== -- cgit v1.2.1