Incorrect instructions in documentation `Contributing` section
- Dominant language
- Python
- Stars
- 37
- Forks
- 7
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 17
Description
### Description of the modifications
The Contributing section has incorrect instructions for building documentation and running tests.
Documentation:
https://twin.docs.pyansys.com/version/stable/contributing.html#build-documentation
Refers to using requirements_doc.txt to install dependencies, but this file no longer exists
Tests:
https://twin.docs.pyansys.com/version/stable/contributing.html#run-unitary-tests
The listed command requires `pytest-cov` and `pytest-forked` in addition to `pytest`, but the instructions only mention the latter.
### Useful links and references
[Contributing](https://twin.docs.pyansys.com/version/stable/contributing.html#run-unitary-tests)
Contributor guide
Research direction
Open the linked Contributing documentation and locate the source for its build-documentation and run-unitary-tests sections. Check the current documentation dependency file and test dependencies, then update both instructions so they match the repository; done means the links no longer reference the missing file and list all required test packages.
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
- Clearly specified
- Newbie friendliness
- 65/100