Phase 6: strip signature-restating docstrings; correct README/SETUP
- Collapsed Args:/Returns:/Raises: blocks that only restated the signature (364 lines): tektronix_base 48% -> ~20% doc density, helios_laser and uc480_camera likewise. Only docstrings whose entire body was those sections were touched. - Preserved verbatim the comments that carry hardware knowledge the code can't express: uc480's USB split-transaction contention note (with its measured fps), the IS_ALLOW_STARTER_FW_UPLOAD segfault explanation, the QImage-copy rationale, and tektronix's NUMFRAMESACQuired warning. - README: project structure, quick start, and every usage example now describe code that exists (they referenced hardware/bbd202.py, CoherentHOPSLaser, get_curve_binary, and 'python -m scanengine.app', none of which do). Added a headless-scan example and a read-a-scan-file example, since reuse without the GUI is the point of the refactor. - SETUP: structure section defers to README instead of keeping a second stale copy; documents the vendored uEye SDK and the Genesis quarantine. - ruff is now clean repo-wide: fixed the remaining raise-from, unused loop variables, placeholder f-strings, and a non-strict zip; the widget-layout semicolon idiom is an explicit config ignore rather than 22 standing warnings. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -9,11 +9,11 @@ select = ["F", "E7", "E9", "B"]
|
||||
ignore = [
|
||||
"E731", # lambda assignment — used deliberately for short Qt slot glue
|
||||
"E741", # ambiguous single-letter names — used in math-heavy geometry code
|
||||
"E702", # `w = QLabel(); w.setFont(f)` on one line — the widget-layout idiom here
|
||||
]
|
||||
|
||||
[lint.per-file-ignores]
|
||||
# Wildcard re-exports are part of this package's (legacy) public surface
|
||||
# until Phase 1 empties it.
|
||||
"hardware/__init__.py" = ["F401", "F403"]
|
||||
"hardware/pybbd202/__init__.py" = ["F401", "F403"]
|
||||
"scanning/__init__.py" = ["F401", "F403"]
|
||||
# Deliberate package re-exports
|
||||
"hardware/pybbd202/__init__.py" = ["F401"]
|
||||
# Quarantined pending hardware verification (docs/genesis_verification.md)
|
||||
"tools/genesis_laser_gui.py" = ["B007"]
|
||||
|
||||
Reference in New Issue
Block a user