Mention category in a note of the writing tests tutorial (infra) (#1549)

* Mention category in a note * Update docs/tutorial/writing-tests/test-case.rst Co-authored-by: Pierre Equoy <[email protected]> --------- Co-authored-by: Pierre Equoy <[email protected]>
canonical · Nov 6, 2024 · 75c2eeb · 75c2eeb
1 parent 086d1dc
commit 75c2eeb
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/tutorial/writing-tests/test-case.rst b/docs/tutorial/writing-tests/test-case.rst
@@ -151,6 +151,13 @@ like this:
     ==================================[ Results ]===================================
      ☑ : Test that the internet is reachable
 
+.. note::
+   Similarly to ``summary`` and ``id``, consider also providing a ``category``
+   for your tests. It makes the output easier to read and clearer (you can see
+   that we are getting an ``uncategorised`` category right now). Additionally
+   it is used in the Test Selection screen to group your tests, so when you
+   have many of them, it makes sifting through them that much easier.
+
 Dependencies
 ============