Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Order of messages #8326

Merged
merged 2 commits into from
Feb 22, 2023

Conversation

stdedos
Copy link
Contributor

@stdedos stdedos commented Feb 22, 2023

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.

Type of Changes

Type
📜 Docs

Description

Refs #8287

Closes #8321

In pylint-dev#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
pylint-dev#8287 (comment)

"Message emitted" is technically still code (`%-formatting`);
let us make it stand out properly.

Signed-off-by: Stavros Ntentos <[email protected]>
@codecov
Copy link

codecov bot commented Feb 22, 2023

Codecov Report

Merging #8326 (59efb44) into main (d025472) will not change coverage.
The diff coverage is n/a.

❗ Current head 59efb44 differs from pull request most recent head dd8d3da. Consider uploading reports for the commit dd8d3da to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #8326   +/-   ##
=======================================
  Coverage   95.46%   95.46%           
=======================================
  Files         177      177           
  Lines       18703    18703           
=======================================
  Hits        17855    17855           
  Misses        848      848           

@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 Skip news 🔇 This change does not require a changelog entry labels Feb 22, 2023
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this :) The warning that make the pipeline fail is : WARNING: Inline literal start-string without end-string.. You can test locally with tox -e docs or cd doc/;make html

Wrapping "Message emitted" in monospaced formatting,
causes `W1507` (`pylint/checkers/stdlib.py`) to fail on a stray space.

Fix that - as it seems to be the only outlier.
(Might've been nice for a more formal check in the first place 🙏).

Signed-off-by: Stavros Ntentos <[email protected]>
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

@stdedos
Copy link
Contributor Author

stdedos commented Feb 22, 2023

@Pierre-Sassoulas Pierre-Sassoulas merged commit f54dfd1 into pylint-dev:main Feb 22, 2023
@github-actions
Copy link
Contributor

🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉

This comment was generated for commit dd8d3da

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📗 Skip news 🔇 This change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation question: Order of messages
2 participants