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.

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

Improve api docs cosmos db #35300

Merged
merged 4 commits into from
Jun 6, 2023
Merged

Improve api docs cosmos db #35300

merged 4 commits into from
Jun 6, 2023

Conversation

tangerinous
Copy link
Contributor

Description

The PR adds additional information to the java docs according to the issue

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

@@ -0,0 +1,152 @@
package com.azure.cosmos;
Copy link
Member

Choose a reason for hiding this comment

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

missing new file license header

import java.util.Collections;
import java.util.List;

public class ContainerAsyncCodeSnippets {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
public class ContainerAsyncCodeSnippets {
public class AsyncContainerCodeSnippets {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for your feedback. I have renamed this class.

private final String serviceEndpoint = "<service-endpoint>";
private final String key = "<key>";
private final DirectConnectionConfig directConnectionConfig = new DirectConnectionConfig();
private final GatewayConnectionConfig gatewayConnectionConfig = new GatewayConnectionConfig();
Copy link
Member

Choose a reason for hiding this comment

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

looks like these connection configs are not used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed it

@tangerinous tangerinous merged commit 667d5c9 into main Jun 6, 2023
@tangerinous tangerinous deleted the ImproveApiDocsCosmosDb branch June 6, 2023 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants