Skip to content

Commit

Permalink
Documentation: Order of messages
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
stdedos authored and Pierre-Sassoulas committed Feb 22, 2023
1 parent 7893fd2 commit b995af4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/exts/pylint_messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def _get_example_code(data_path: Path) -> str:
)

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


def _get_pylintrc_code(data_path: Path) -> str:
Expand Down Expand Up @@ -307,7 +307,7 @@ def _generate_single_message_body(message: MessageData) -> str:
{get_rst_title(f"{message.name} / {message.id}", "=")}
**Message emitted:**
{message.definition.msg}
``{message.definition.msg}``
**Description:**
Expand Down

0 comments on commit b995af4

Please sign in to comment.