Skip to content

[doc framework] Assert that the good and bad example exists in the doc#9936

Merged
Pierre-Sassoulas merged 3 commits intopylint-dev:mainfrom
Pierre-Sassoulas:assert-doc-exists
Sep 20, 2024
Merged

[doc framework] Assert that the good and bad example exists in the doc#9936
Pierre-Sassoulas merged 3 commits intopylint-dev:mainfrom
Pierre-Sassoulas:assert-doc-exists

Conversation

@Pierre-Sassoulas
Copy link
Copy Markdown
Member

Type of Changes

Type
📜 Docs

Description

Following #9933 that closed #5953, we're now able to check that we have a good example and a bad example. Some message need to be permitted to not have examples. This permitted to catch a typo in the doc (unrecognize-option) but we could check that no directory that shouldn't exists do, too.

@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 Maintenance Discussion or action around maintaining pylint or the dev workflow Skip news 🔇 This change does not require a changelog entry labels Sep 19, 2024
@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.80%. Comparing base (0950916) to head (b40b1d2).
Report is 80 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #9936   +/-   ##
=======================================
  Coverage   95.80%   95.80%           
=======================================
  Files         174      174           
  Lines       18933    18933           
=======================================
  Hits        18139    18139           
  Misses        794      794           

@Pierre-Sassoulas Pierre-Sassoulas merged commit bd97b93 into pylint-dev:main Sep 20, 2024
@Pierre-Sassoulas Pierre-Sassoulas deleted the assert-doc-exists branch September 20, 2024 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation 📗 Maintenance Discussion or action around maintaining pylint or the dev workflow Skip news 🔇 This change does not require a changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HELP WANTED: Help copy content from pylint-errors over to our own documentation

2 participants