Skip to content

Fix typos in the start_advertising() param docs#9248

Merged
tannewt merged 1 commit intoadafruit:mainfrom
andrewguest:fix-bleio-doc-typo
May 15, 2024
Merged

Fix typos in the start_advertising() param docs#9248
tannewt merged 1 commit intoadafruit:mainfrom
andrewguest:fix-bleio-doc-typo

Conversation

@andrewguest
Copy link

I noticed there are two small typos in the parameters for the _bleio.Adapter.start_advertising() method. In the Parameters list, two lines had the parameter name and data type values switched. The data type should be listed after :param and before the parameter's name.

The two parameters are currently listed as:

  • int (tx_power) – transmitter power while advertising in dBm
  • Address (directed_to) – peer to advertise directly to

The data type should be in the parentheses, not the parameter's name:

  • tx_power (int) – transmitter power while advertising in dBm
  • directed_to (Address) – peer to advertise directly to

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thank you!

@tannewt tannewt merged commit 3178d38 into adafruit:main May 15, 2024
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.

2 participants