In "Messages Overview", show the bad_code first

It makes more sense to _first define the problem_, then solve it. Mentions issue pylint-dev#7143 Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com>
stdedos · Jul 11, 2022 · 4036736 · 4036736
1 parent a359796
commit 4036736
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/doc/exts/pylint_messages.py b/doc/exts/pylint_messages.py
@@ -272,8 +272,8 @@ def _generate_single_message_body(message: MessageData) -> str:
 
 *{message.definition.description}*
 
-{message.good_code}
 {message.bad_code}
+{message.good_code}
 {message.details}
 {message.related_links}
 """

diff --git a/doc/whatsnew/2/2.15/index.rst b/doc/whatsnew/2/2.15/index.rst
@@ -86,6 +86,10 @@ Other Changes
 
   Closes #6953
 
+* In Documentation, in "Messages Overview", show the `bad_code` first (instead of showing the correct code first)
+
+  Refs #7143
+
 
 Internal changes
 ================