Messages in this thread | | | From | Daniel Latypov <> | Date | Tue, 25 Oct 2022 10:53:01 -0700 | Subject | Re: [PATCH] Documentation: kunit: Remove redundant 'tips.rst' page |
| |
On Mon, Oct 24, 2022 at 10:58 PM David Gow <davidgow@google.com> wrote: > > The contents of 'tips.rst' was included in 'usage.rst' way back in > commit 953574390634 ("Documentation: KUnit: Rework writing page to focus on writing tests"), > but the tips page remained behind as well. > > Therefore, delete 'tips.rst' > > While I regret breaking any links to 'tips' which might exist > externally, it's confusing to have two subtly different versions of the > same content around. > > Signed-off-by: David Gow <davidgow@google.com>
I liked tips.rst, but I agree we should probably remove it for the sake of deduping.
The only blocker in my mind is we're missing an equivalent of: https://www.kernel.org/doc/html/latest/dev-tools/kunit/tips.html#customizing-error-messages
Non-blocker: we have a duplicate section on assertion vs expectations: https://www.kernel.org/doc/html/latest/dev-tools/kunit/usage.html#assertions https://www.kernel.org/doc/html/latest/dev-tools/kunit/usage.html#exiting-early-on-failed-expectations
Daniel
| |