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

Missing Documentation for ContinuationTokenSpecification #320

Open
philip-reed opened this issue Jan 31, 2023 · 2 comments
Open

Missing Documentation for ContinuationTokenSpecification #320

philip-reed opened this issue Jan 31, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed up-for-grabs 🙏🏽 Happy to consider a pull review to address this issue

Comments

@philip-reed
Copy link
Contributor

We are continuously addressing and improving the SDK, if possible, make sure the problem persist in the latest SDK version.

Describe the bug
Missing Documentation for ContinuationTokenSpecification.

To Reproduce
Section missing from docs site here:
https://ievangelist.github.io/azure-cosmos-dotnet-repository/4-queries/specification-pattern/

Expected behavior
An explanation on how this type is used.

Actual behavior
N/A

Environment summary
N/A

Additional context
I stumbled on this missing documentation when trying to understand how the ContinuationTokenSpecification should be used for initial calls where there isn't a continuation token available yet. (The continuationToken parameter to the constructor is not nullable).

@IEvangelist IEvangelist added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 31, 2023
@mumby0168
Copy link
Collaborator

@philip-reed I think this was done pre-nullables and probably should be updated, the docs should also be added to to clarify the use of this type, in the meantime checkout the samples here:

https://github.com/IEvangelist/azure-cosmos-dotnet-repository/blob/2a9b39b8446051a71e7176977abd224a51aeae9b/samples/Microsoft.Azure.CosmosRepository/Specification/SpecificationPagingSamples.cs#LL42C8-L42C88

@philip-reed
Copy link
Contributor Author

It looks like ContinuationToken property is nullable on the BaseSpecification, so this hints that I should be ok to pass a null through on the ctor. Maybe you're right @mumby0168 and this just wants nullable adding to the ContinuationTokenSpecification continuationToken parameter?

@IEvangelist IEvangelist added the up-for-grabs 🙏🏽 Happy to consider a pull review to address this issue label Apr 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed up-for-grabs 🙏🏽 Happy to consider a pull review to address this issue
Projects
None yet
Development

No branches or pull requests

3 participants