Skip to content

docs(providers): improve TeleopsStatusProvider __init__ docstring #1830

Merged
openminddev merged 1 commit intoOpenMind:mainfrom
chongru1988:docs/improve-teleops-status-provider-docstrings
Jan 26, 2026
Merged

docs(providers): improve TeleopsStatusProvider __init__ docstring #1830
openminddev merged 1 commit intoOpenMind:mainfrom
chongru1988:docs/improve-teleops-status-provider-docstrings

Conversation

@chongru1988
Copy link
Copy Markdown
Contributor

I noticed that the TeleopsStatusProvider.__init__ method had a type mismatch in its docstring. The api_key parameter was documented as str, but the actual code uses Optional[str] = None.

I've updated the docstring to:

  • Fix the type annotation for api_key parameter (changed from str to Optional[str])
  • Add more detailed initialization description explaining the setup of API authentication and base URL
  • Document the ThreadPoolExecutor initialization for asynchronous status sharing operations

This should make it clearer for developers using the TeleopsStatusProvider class! Hope this helps!

@chongru1988 chongru1988 requested review from a team as code owners January 22, 2026 15:25
@github-actions github-actions Bot added robotics Robotics code changes python Python code labels Jan 22, 2026
@openminddev openminddev merged commit 218060b into OpenMind:main Jan 26, 2026
1 check 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