Bluetooth API documentation - bt_conn_create_slave_le

[MarekPieta]

Bluetooth API documentation for fuction bt_conn_create_slave_le states:

"The advertising type must be either BT_LE_ADV_DIRECT_IND or BT_LE_ADV_DIRECT_IND_LOW_DUTY."

I think it may be a bit misleading, since it does not appear as one of function argmuents. Maybe we could make it a condition for function argument: const struct bt_le_adv_param *param?

[jhedberg]

--- a/include/bluetooth/conn.h
+++ b/include/bluetooth/conn.h
@@ -231,8 +231,9 @@ int bt_le_set_auto_conn(const bt_addr_le_t *addr,
  *  Allows initiating a new LE connection to remote peer with the remote
  *  acting in central role and the local device in peripheral role.
  *
- *  The advertising type must be either BT_LE_ADV_DIRECT_IND or
- *  BT_LE_ADV_DIRECT_IND_LOW_DUTY.
+ *  The advertising type will either be BT_LE_ADV_DIRECT_IND, or
+ *  BT_LE_ADV_DIRECT_IND_LOW_DUTY if the BT_LE_ADV_OPT_DIR_MODE_LOW_DUTY
+ *  option was used as part of the advertising parameters.
  *
  *  In case of high duty cycle this will result in a callback with
  *  connected() with a new connection or with an error.

@MarekPieta would that make it clear?