Skip to content

Improve documentation coverage across ODrive tools and guides#15

Draft
Copilot wants to merge 2 commits intomasterfrom
copilot/improve-documentation-coverage
Draft

Improve documentation coverage across ODrive tools and guides#15
Copilot wants to merge 2 commits intomasterfrom
copilot/improve-documentation-coverage

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 24, 2026

Key public functions in the Python tools had no docstrings, and the RST user-facing docs had typos, gaps in troubleshooting, and missing parameter descriptions.

Python docstrings (tools/odrive/)

  • utils.py — Added Google-style docstrings to 13 undocumented public functions: get_serial_number_str, get_serial_number_str_sync, calculate_thermistor_coeffs, set_motor_thermistor_coeffs, dump_errors (with usage examples), oscilloscope_dump, step_and_plot (with units), show_oscilloscope, yes_no_prompt, dump_interrupts, dump_threads, dump_dma, dump_timing
  • configuration.py — Docstrings for obj_to_path, get_dict, set_dict, get_temp_config_filename
  • shell.py — Docstrings for print_banner, print_help, benchmark

Example of what was missing:

def dump_errors(odrv, clear=False, printfunc=print):
    """
    Prints all active errors for each axis and submodule of an ODrive device.
    ...
    Example:
        >>> dump_errors(odrv0)
        >>> dump_errors(odrv0, clear=True)
    """

RST documentation

  • getting-started.rst — Fixed section heading typo odriveoolodrivetool; fixed dos notdoes not
  • troubleshooting.rst — Added four new sections: motor not responding to commands, ODrive not appearing on USB, calibration failing with MOTOR_ERROR_PHASE_RESISTANCE_OUT_OF_RANGE, and encoder CPR/position drift
  • commands.rst — Added M0/M1 → axis0/axis1 connector mapping note; added vbus_voltage and ibus to the Diagnostics section with units and descriptions
Original prompt

This section details on the original issue you should resolve

<issue_title>Improve Documentation Coverage</issue_title>
<issue_description>## Issue Summary
The current documentation is insufficient and needs improvement to better support users and developers.

Problem

The existing documentation lacks sufficient coverage of key features, configuration options, and usage examples. This makes it difficult for new users to get started and for developers to contribute effectively.

Suggested Improvements

  • Add more comprehensive getting started guides
  • Include more code examples and use cases
  • Expand API documentation with detailed parameter descriptions
  • Add troubleshooting guides for common issues
  • Improve inline code comments

Impact

Better documentation will:

  • Reduce support burden
  • Improve developer onboarding
  • Increase community contributions
  • Enhance overall user experience</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

… docs

Co-authored-by: lifesawesome <165964916+lifesawesome@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation coverage for users and developers Improve documentation coverage across ODrive tools and guides Feb 24, 2026
Copilot AI requested a review from lifesawesome February 24, 2026 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Documentation Coverage

2 participants