AcademySoftwareFoundation / AcademySoftwareFoundation/rez
update docs/add warning when conf settings defined in package.py are ignored
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 369
- Avg merge
- 12d 3h
- Merged PRs (30d)
- 5
Description
Only a subset of the config settings are actually used if redefined in a package.py. For example, those affecting the resolve (packages_path etc) are ignored, because by the time the package.py is read, the resolve is already underway.
The docs should more clearly describe this, and these settings should be detected in package.py's and produce a warning to the effect that they're being ignored.
Contributor guide
Research direction
Start by locating the documentation describing configuration settings and the package.py loading path. Compare settings used during resolve with settings read afterward, then define the warning behavior for ignored settings. Done means the documentation clearly explains the limitation and package.py definitions of those settings produce a warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100