Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add code examples for public APIs in IotHubDeviceClient, IotHubModuleClient, IotHubBaseClient and retry policies #3308

Merged
merged 6 commits into from
Apr 28, 2023
Merged

Add code examples for public APIs in IotHubDeviceClient, IotHubModuleClient, IotHubBaseClient and retry policies #3308

merged 6 commits into from
Apr 28, 2023

Conversation

brycewang-microsoft
Copy link
Contributor

No description provided.

@brycewang-microsoft brycewang-microsoft changed the title Add code examples for public APIs in IotHubDeviceClient, IotHubModule… Add code examples for public APIs in IotHubDeviceClient, IotHubModuleClient and IotHubBaseClient Apr 27, 2023
@brycewang-microsoft
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@brycewang-microsoft brycewang-microsoft changed the title Add code examples for public APIs in IotHubDeviceClient, IotHubModuleClient and IotHubBaseClient Add code examples for public APIs in IotHubDeviceClient, IotHubModuleClient, IotHubBaseClient and retry policies Apr 27, 2023
drwill-ms
drwill-ms reviewed Apr 28, 2023
View reviewed changes
iothub/device/src/IotHubModuleClient.cs
/// <code language="csharp">
/// await using var client = await IotHubModuleClient.CreateFromEnvironmentAsync(new IotHubClientOptions(new IotHubClientMqttSettings(IotHubClientTransportProtocol.WebSocket)));
/// </code>
/// </example>
public static async Task<IotHubModuleClient> CreateFromEnvironmentAsync(IotHubClientOptions options = default)
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason why we don't have a cancellation token in this async method?

Not for your PR, Bryce, but maybe we should add a task to add one here.

drwill-ms
drwill-ms approved these changes Apr 28, 2023
View reviewed changes
Copy link
Contributor

@drwill-ms drwill-ms left a comment

Choose a reason for hiding this comment

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

I may not be able to see the changes that come out of this, but I feel it is low risk as it is just doc comments. I'm signing off optimistically to help you finish it without me bottlenecking ya. :)

@brycewang-microsoft
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@brycewang-microsoft brycewang-microsoft merged commit 20f0f4f into previews/v2 Apr 28, 2023
@brycewang-microsoft brycewang-microsoft deleted the brycewang/doc-comments branch April 28, 2023 21:33
@patilsnr patilsnr mentioned this pull request Jul 31, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmahmood-microsoft tmahmood-microsoft tmahmood-microsoft approved these changes

@drwill-ms drwill-ms drwill-ms approved these changes

@timtay-microsoft timtay-microsoft Awaiting requested review from timtay-microsoft timtay-microsoft is a code owner

@abhipsaMisra abhipsaMisra Awaiting requested review from abhipsaMisra abhipsaMisra is a code owner

@andyk-ms andyk-ms Awaiting requested review from andyk-ms andyk-ms is a code owner

@patilsnr patilsnr Awaiting requested review from patilsnr patilsnr is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@brycewang-microsoft @drwill-ms @abhipsaMisra @tmahmood-microsoft