Using all the snippet for readme are being used#49216
Open
jpalvarezl wants to merge 1 commit into
Open
Conversation
jpalvarezl
requested review from
a team,
dargilco,
glecaros,
kaylieee and
trrwilson
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the azure-ai-projects documentation and samples scaffolding to better align README code blocks with existing sample snippets, removing an unused snippet marker and expanding the README’s examples to cover more sub-clients and operations.
Changes:
- Removed an unused/empty snippet marker block from
ReadmeSamples.java. - Expanded
README.mdexamples to include more synchronous and asynchronous operations across Connections, Deployments, Datasets, Indexes, and Skills. - Restructured/clarified the Examples section with additional headings and snippet references.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| sdk/ai/azure-ai-projects/src/samples/java/com/azure/ai/projects/ReadmeSamples.java | Removes an unused snippet marker block from the generated README samples holder. |
| sdk/ai/azure-ai-projects/README.md | Adds many more operation-specific code snippets and improves organization of the Examples section. |
Comment on lines
+148
to
+152
| ```java com.azure.ai.projects.ConnectionsAsyncSample.listConnections | ||
|
|
||
| return connectionsAsyncClient.listConnections() | ||
| .doOnNext(connection -> System.out.printf("Connection name: %s%n", connection.getName())); | ||
|
|
|
|
||
| ```java com.azure.ai.projects.IndexesDeleteSample.deleteIndex | ||
|
|
||
| String indexName = "test-index"; //Configuration.getGlobalConfiguration().get("INDEX_NAME", "my-index"); |
kaylieee
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request makes a minor cleanup in the
ReadmeSamples.javafile by removing unused sample code comment markers. No functional code changes are included.Using all unused snippets in the README