Skip to content

docs: fix parameter documentation in RFData and RFDataRaw classes#1506

Merged
openminddev merged 5 commits intoOpenMind:mainfrom
windlgrass:docs-rfdataraw-fix-parameters
Jan 19, 2026
Merged

docs: fix parameter documentation in RFData and RFDataRaw classes#1506
openminddev merged 5 commits intoOpenMind:mainfrom
windlgrass:docs-rfdataraw-fix-parameters

Conversation

@windlgrass
Copy link
Copy Markdown
Contributor

Fixes parameter documentation issues in RF data classes

Issues:

  1. RFData dataclass has 8 fields but only 4 are documented
  2. RFDataRaw docstring incorrectly documents name parameter which doesn't exist, and is missing packet parameter

Changes:

  • RFData class:

    • Line 25: Updated name type to str | None to match dataclass
    • Lines 29-36: Added 4 missing parameters (tx_power, service_uuid, mfgkey, mfgval)
  • RFDataRaw class:

    • Lines 72-73: Removed incorrect name parameter
    • Lines 82-83: Added missing packet parameter

File: src/providers/fabric_map_provider.py

@windlgrass windlgrass requested review from a team as code owners January 16, 2026 03:10
@github-actions github-actions Bot added robotics Robotics code changes python Python code labels Jan 16, 2026
windlgrass and others added 3 commits January 18, 2026 10:45
Replaces union type hints (str | None, int | None) with Optional[str] and Optional[int] for the 'name' and 'tx_power' attributes in the RFData class for improved type clarity and compatibility.
@openminddev openminddev merged commit b7ef12a into OpenMind:main Jan 19, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Python code robotics Robotics code changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants