Skip to content

docs: Fix ISM330DLC references to ISM330DL in root README.#120

Merged
nedseb merged 1 commit intomainfrom
fix/readme-ism330dl
Mar 14, 2026
Merged

docs: Fix ISM330DLC references to ISM330DL in root README.#120
nedseb merged 1 commit intomainfrom
fix/readme-ism330dl

Conversation

@nedseb
Copy link
Copy Markdown
Contributor

@nedseb nedseb commented Mar 14, 2026

Closes #119

Summary

  • Rename ism330dlc/ism330dl/ in the directory tree
  • Rename ISM330DLCTRISM330DL in the driver section
  • Update the API example to match the actual driver (ISM330DL, acceleration_g(), gyroscope_dps(), configure_accel())
  • Fix the example command path (lib/ism330dl/examples/basic_read.py)

Test plan

  • No code changes, documentation only

@nedseb nedseb requested a review from Copilot March 14, 2026 15:35
@nedseb nedseb self-assigned this Mar 14, 2026
@nedseb nedseb added the documentation Improvements or additions to documentation label Mar 14, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the root README to reference the correct ISM330DL driver (directory name, class name, and API) so the documentation matches the actual driver shipped in lib/ism330dl.

Changes:

  • Fix the repository tree entry to lib/ism330dl/ and the driver name to ISM330DL.
  • Update the README usage example to the real ISM330DL API (acceleration_g(), gyroscope_dps(), temperature_c(), configure_accel()).
  • Correct the mpremote example command to run lib/ism330dl/examples/basic_read.py.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nedseb nedseb merged commit 1d4d9f3 into main Mar 14, 2026
7 checks passed
@nedseb nedseb deleted the fix/readme-ism330dl branch March 14, 2026 19:53
@semantic-release-updater
Copy link
Copy Markdown

🎉 This PR is included in version 0.0.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Fix ISM330DLC references in root README to ISM330DL.

2 participants