Skip to content

KnownIssues.md

Latest commit

 

History

History
60 lines (47 loc) · 2.93 KB

KnownIssues.md

File metadata and controls

60 lines (47 loc) · 2.93 KB

Known Issues

This document tracks known issues, limitations, and workarounds for this project.

Current Type Checking False Positives

Total False Positive Type Errors: 5 across 3 files Runtime Stability: Excellent - All core features functional

Syntax Highlighter String-Bytes Concatenation (False Positive)

  • File: src/syntax_highlighter.py:130
  • Description: Mypy incorrectly reports "Unsupported operand types for + ("str" and "bytes")"
  • Actual Behavior: The code works correctly - all color values are properly handled as strings
  • Impact: None - this is a mypy false positive
  • Status: Won't Fix - False positive type checking error
  • Workaround: Ignore this mypy error as the runtime behavior is correct

Smart Tab Hook Return Type (False Positive)

  • File: hooks/smart-tab/smart_tab__90.py:85
  • Description: Mypy incorrectly reports "Returning Any from function declared to return 'str'"
  • Actual Behavior: The function correctly returns strings in all execution paths
  • Impact: None - this is a mypy false positive
  • Status: Won't Fix - False positive type checking error
  • Workaround: Ignore this mypy error as the runtime behavior is correct

Text Buffer None Object Iteration (False Positives)

  • Files: src/text_buffer.py:244, 315, 421
  • Description: Mypy incorrectly reports ""None" object is not iterable" in multiple locations
  • Actual Behavior: The buffer manager properly initializes lines and null checks are performed
  • Impact: None - these are mypy false positives
  • Status: Won't Fix - False positive type checking errors
  • Workaround: Ignore these mypy errors as the runtime behavior is correct

General Code Quality Notes

Type Safety

  • Description: Mypy reports some false positive type errors due to complex runtime patterns
  • Impact: Development tooling noise, but no runtime issues
  • Status: Known limitation of static type checking with dynamic patterns
  • Workaround: Focus on runtime testing rather than complete type safety

Editor Functionality

  • Important: Despite the mypy errors, the editor works correctly in all tested scenarios
  • Testing: All core functionality (editing, navigation, selection, copy/paste) has been verified
  • Reliability: The application is stable and functional despite type checker warnings

Development Guidelines

For Developers:

  1. Runtime Testing: Prioritize functional testing over type checking compliance
  2. Selective Fixing: Only address mypy errors that correspond to actual runtime issues
  3. Documentation: Continue documenting false positives in this file

For Users:

  1. Ignore Type Warnings: The mypy errors do not affect application functionality
  2. Report Actual Bugs: Focus on reporting runtime issues rather than type checking warnings
  3. Stability: The application is production-ready despite type checker limitations

Last Updated: 02.09.2025