docs: document public usage (manager, wrappers, active scan) - #538
Draft
bluetoothbot wants to merge 1 commit into
Draft
docs: document public usage (manager, wrappers, active scan)#538bluetoothbot wants to merge 1 commit into
bluetoothbot wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #538 +/- ##
=======================================
Coverage 99.59% 99.59%
=======================================
Files 15 15
Lines 2689 2689
Branches 386 386
=======================================
Hits 2678 2678
Misses 1 1
Partials 10 10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merging this PR will not alter performance
Comparing Footnotes
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What: Replace the
TODO: Document usagestub indocs/usage.mdwith a real, code-grounded usage guide.Why: The published docs (readthedocs) had no usage content for a library with a 38-symbol public API. Anyone landing on the Usage page got
import habluetoothand a TODO. This fills the gap without touching code.How: Documents the actual public surface, every claim verified against the source:
BluetoothManagersingleton +get_manager/set_manager/async_setup/async_stoplifecycleHaBleakScannerWrapper/HaBleakClientWrapperas drop-in bleak replacementsasync_last_service_info,async_discovered_service_info,async_ble_device_from_address, …)async_register_active_scan/async_request_active_scan), including the clamp/coalesce semantics from their docstringsTesting:
prettier --checkandcodespellpass on the file. Docs-only change (docs:type, excluded from the changelog); no source touched, full test suite unaffected.Quality Report
Changes: 1 file changed, 181 insertions(+), 1 deletion(-)
Code scan: 2 issue(s) found
docs/usage.md:72— debug print statementdocs/usage.md:113— debug print statementTests: failed (FAILED)
Branch hygiene: clean
Generated by Kōan