add documentation for linting#2166
Merged
Gold856 merged 7 commits intoPhotonVision:mainfrom Nov 2, 2025
Merged
Conversation
github-actions
bot
added
the
documentation
samfreund
force-pushed
the
lint-docs
branch
6 times, most recently
from
32b09ce to
3c43794
Compare
Member
|
Still not sure how to feel about pipx. I always used pip on Windows. Maybe suggest a venv? |
This comment was marked as outdated.
This comment was marked as outdated.
Gold856
requested changes
Nov 2, 2025
Gold856
approved these changes
Nov 2, 2025
spacey-sooty
pushed a commit
to spacey-sooty/photonvision
that referenced
this pull request
Dec 22, 2025
## Description This adds documentation for how to lint PhotonVision, as it is not available elsewhere and people have historically needed to figure it out for themselves. It also adds an alias for linting PV. ## Meta Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_ - [ ] If this PR changes behavior or adds a feature, user documentation is updated - [ ] If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly - [ ] If this PR touches configuration, this is backwards compatible with settings back to v2025.3.2 - [ ] If this PR touches pipeline settings or anything related to data exchange, the frontend typing is updated - [ ] If this PR addresses a bug, a regression test for it is added
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
2 participants
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.
Description
This adds documentation for how to lint PhotonVision, as it is not available elsewhere and people have historically needed to figure it out for themselves. It also adds an alias for linting PV.
Meta
Merge checklist: