search

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.63k stars 2.84k forks source link

Unclear documentation of function publish_telemetry #30667

Closed kleegrewec closed 1 year ago

kleegrewec commented 1 year ago

From my perspective the documentation of function "publish_telemetry" is unclear. The description

'Publish telemetry **from** a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under...'

suggests that telemetry data is pushed out from the twin and not into it. Please change this to some more clear description.

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

github-actions[bot] commented 1 year ago

Thank you for your feedback. This has been routed to the support team for assistance.

navba-MSFT commented 1 year ago

@kleegrewec Apologies for the late reply. Thanks for reaching out to us and reporting this issue. We are looking into this issue and we will provide an update.

navba-MSFT commented 1 year ago

@kleegrewec The above PR has been filed and it is currently under review. Thanks again for your feedback on improving our docs.