pytest-dev / pytest-dev/pytest-html

Documentation should not list unreleased features (such as config option `environment_table_redact_list`)

Open
#511 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
779
Forks
260
PR merge metrics
No merged PRs in 30d

Description

Hi,
I tried setting the environment_table_redact_list in variable in my pytest.ini file order to remove certain rows from the Environment table and got the following error:
PytestConfigWarning: Unknown config option: environment_table_redact_list

pytest.ini content:
[pytest]
environment_table_redact_list = Packages

Output of pip list:
Package Version


attrs 21.4.0
iniconfig 1.1.1
numpy 1.22.3
packaging 21.3
pandas 1.4.2
pexpect 4.8.0
pip 22.0.4
pkg_resources 0.0.0
pluggy 1.0.0
ptyprocess 0.7.0
py 1.11.0
pyparsing 3.0.8
pyserial 3.5
pytest 7.1.1
pytest-html 3.1.1
pytest-metadata 2.0.1
pytest-timeout 2.1.0
python-dateutil 2.8.2
pytz 2022.1
setuptools 44.0.0
six 1.16.0
tomli 2.0.1

python 3.8.10 on Ubuntu 20.04

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No documentation file or test is named in the issue. Search the project documentation for environment_table_redact_list and verify whether it describes an unreleased option; done means released documentation no longer presents that option as available.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.