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

update the Cosmos crate README #2039

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

analogrelay
Copy link
Member

This is a first pass at updating the README for the azure_data_cosmos crate. I based this on the Go package (https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/data/azcosmos/README.md) and updated the syntax and added some notes about the differences. I also borrowed from the ongoing work @ronniegeraghty is doing for the Identity create in #1990)

Please take a close look to make sure I got all the Go related stuff converted properly. I'm also doing some further editing passes, but wanted to open things up for folks so they can take some time to find errors I may have made.

@analogrelay
Copy link
Member Author

We've got a bit of a build issue. The README.md file is embedded as documentation for the root of the crate, which means it builds as doctests. I think this is a Good Thing ™️ since it ensures our README samples compile properly. However, we do that build without --all-features, so it's currently failing when building the examples that use CosmosClient::with_key, since that method requires the key_auth feature. Also, I can't use any of the rustdoc "attributes" on the code block (like no_compile) to avoid that because they will break syntax highlighting on the README on GitHub (and possibly crates.io, though I'd hope they can support those attributes).

@heaths Are we able to add --all-features to the tests runs in eng/scripts/Test-Packages.ps1? I believe that's the script that's failing. I'm happy to do it, but I wanted to check in with you first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant