Skip to content

Update documentation on writing tests for pylint#5366

Merged
Pierre-Sassoulas merged 4 commits into
pylint-dev:mainfrom
DanielNoord:contributing
Nov 22, 2021
Merged

Update documentation on writing tests for pylint#5366
Pierre-Sassoulas merged 4 commits into
pylint-dev:mainfrom
DanielNoord:contributing

Conversation

@DanielNoord
Copy link
Copy Markdown
Collaborator

  • Add yourself to CONTRIBUTORS if you are a new contributor.
  • Write a good description on what the PR does.

Type of Changes

Type
📜 Docs

Description

Thought I shouldn't ask for better documentation while not doing some of it myself. Nobody likes writing docs 😄

Based on my comment in #5365

@coveralls
Copy link
Copy Markdown

coveralls commented Nov 22, 2021

Pull Request Test Coverage Report for Build 1490882619

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.443%

Totals Coverage Status
Change from base Build 1490184161: 0.0%
Covered Lines: 13923
Relevant Lines: 14900

💛 - Coveralls

@DanielNoord DanielNoord marked this pull request as ready for review November 22, 2021 13:02
@DanielNoord
Copy link
Copy Markdown
Collaborator Author

Should probably add primer as well after we have merged it. I'll add it to the to-do list of the follow-up issue.

@Pierre-Sassoulas Pierre-Sassoulas added this to the 2.12.0 milestone Nov 22, 2021
Copy link
Copy Markdown
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.

Amazing 👍 I have some small remarks

Comment thread doc/development_guide/testing.rst
Comment thread doc/development_guide/testing.rst
Comment thread doc/development_guide/testing.rst Outdated
Comment thread doc/development_guide/testing.rst Outdated
Comment on lines +109 to +115
For example, if the configuration should add a warning to the list of disabled messages the
`.json` file should include::

"functional_append": {
"disable": [["a-message-to-be-added"],]
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
For example, if the configuration should add a warning to the list of disabled messages the
`.json` file should include::
"functional_append": {
"disable": [["a-message-to-be-added"],]
}
For example, if the configuration should add a warning to the list of disabled messages
and you changed the configuration for ``job`` to 10 instead of the default 1 the
`.json` file should include::
"functional_append": {
"disable": [["a-message-to-be-added"],]
}
"jobs": 10,

Copy link
Copy Markdown
Collaborator Author

@DanielNoord DanielNoord Nov 22, 2021

Choose a reason for hiding this comment

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

👍

Can't commit this one as well..

Comment thread doc/development_guide/testing.rst Outdated
Comment on lines +42 to +44
python -m tox -e py36 -- -k test_functional
python -m tox -e py36 -- -k \*func\*
python -m tox --recreate -e py36 -- -k test_functional # With recreation of the environment
Copy link
Copy Markdown
Member

@Pierre-Sassoulas Pierre-Sassoulas Nov 22, 2021

Choose a reason for hiding this comment

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

Suggested change
python -m tox -e py36 -- -k test_functional
python -m tox -e py36 -- -k \*func\*
python -m tox --recreate -e py36 -- -k test_functional # With recreation of the environment
python -m tox -e py39 -- -k test_functional
python -m tox -e py39 -- -k \*func\*
python -m tox --recreate -e py39 -- -k test_functional # With recreation of the environment

Also upgraded the version so we appear hype :)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Should we add those last 3 lines? The 5 lines after this basically cover pytest already.

@Pierre-Sassoulas Pierre-Sassoulas merged commit a73021e into pylint-dev:main Nov 22, 2021
@DanielNoord DanielNoord deleted the contributing branch November 22, 2021 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants