arduino / arduino/docs-content

Examples in CurieBLE reference pages don't use the function being documented

Open
#386 0 comments 0 reactions 0 assignees View on GitHub
bug community
Dominant language
Python
Stars
375
Forks
555
Avg merge
4d 3h
Merged PRs (30d)
28

Description

The examples included in the following pages don't use the thing being documented:

- https://www.arduino.cc/en/Reference/BLEPeripheralPoll
- https://www.arduino.cc/en/Reference/BLEPeripheralEnd
- This was previously reported in https://github.com/arduino/Arduino/issues/5375 along with some other issues found on that page.
- https://www.arduino.cc/en/Reference/BLEPeripheralSetDeviceName
- https://www.arduino.cc/en/Reference/BLEPeripheralSetAppearance
- https://www.arduino.cc/en/Reference/BLEPeripheralDisconnect
- https://www.arduino.cc/en/Reference/BLEDescriptorConstructor
- https://www.arduino.cc/en/Reference/BLECentralDisconnect
- https://www.arduino.cc/en/Reference/BLECentralPoll
- https://www.arduino.cc/en/Reference/BLECharacteristicConstructor

Originally reported at http://forum.arduino.cc/index.php?topic=482789

Contributor guide

Open the contributing guide

Research direction

Open the nine CurieBLE reference pages listed in the issue and compare each example with the function or constructor documented on that page. Update the examples so they use the documented item, then verify that every listed page demonstrates its own API correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.