🧹 cleanup settings resolver and README extras guidance#263
Open
Gudsfile wants to merge 2 commits into
Open
Conversation
`if not is_editable_setting_path(dotted_path)` is **always True**, reaching that branch requires both the editable check and the dict check to have been False, meaning the path is already non-editable. The raise at line 320 always fires; `paths.add(dotted_path)` at line 322 is unreachable.
The Developer Setup section says "Add `--all-extras` to install dependencies for all extras (`api` and `ui`)." `AGENTS.md` explicitly prohibit `uv sync --all-extras` because extras are environment-dependent (NFC hardware, Python version). A human contributor reading only the README will follow the contradicted advice. Remove the `--all-extras` recommendation from README.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR cleans up technical debt in the settings resolver and fixes contradictory developer setup documentation.
Changes
Remove unreachable code in the settings resolver.
paths.add(dotted_path)could never be reached because the preceding condition always raised first. Simplifies the control flow and removes dead logic.Update developer setup documentation: remove the
uv sync --all-extrasrecommendation from the README. Align setup instructions withAGENTS.md, since extras are environment-dependent (hardware support, Python version, etc.). Prevent installation issues on unsupported hardware such as PN532/NFC setups.Comments
(I tried https://github.com/ksimback/tech-debt-skill and only considered the simplest issues.)