Skip to content

Commit b995af4

Browse files
stdedosPierre-Sassoulas
authored andcommitted
Documentation: Order of messages
In #7162, "we decreed" that the `bad_code` goes first, then the `good_code`. Fixup current changes, to revert "back to standards". Additionally, tackle the comment here #8287 (comment) "Message emitted" is technically still code (`%-formatting`); let us make it stand out properly. Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com>
1 parent 7893fd2 commit b995af4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/exts/pylint_messages.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def _get_example_code(data_path: Path) -> str:
8484
)
8585

8686
_check_placeholders(data_path, bad_code, details, related)
87-
return "\n".join((good_code, bad_code, pylintrc, details, related)) + "\n"
87+
return "\n".join((bad_code, good_code, pylintrc, details, related)) + "\n"
8888

8989

9090
def _get_pylintrc_code(data_path: Path) -> str:
@@ -307,7 +307,7 @@ def _generate_single_message_body(message: MessageData) -> str:
307307
{get_rst_title(f"{message.name} / {message.id}", "=")}
308308
**Message emitted:**
309309
310-
{message.definition.msg}
310+
``{message.definition.msg}``
311311
312312
**Description:**
313313

0 commit comments

Comments
 (0)