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

Docs: Clarify some points in documentation and typedocs #831

Merged
merged 5 commits into from
Mar 22, 2024

Conversation

adamyeats
Copy link
Contributor

@adamyeats adamyeats commented Mar 19, 2024

This PR clarifies some very minor things that I tripped up on while setting up the E2E tests in grafana/surrealdb-datasource. Please consider this a first pass as I intend on taking another pass at this in future.

(@sunker Again, great job on this, feels like a huge step forward from where we were Cypress! 🚀)

@adamyeats adamyeats added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels Mar 19, 2024
@adamyeats adamyeats self-assigned this Mar 19, 2024
@adamyeats adamyeats requested a review from a team as a code owner March 19, 2024 14:46
@adamyeats adamyeats requested review from oshirohugo and removed request for a team March 19, 2024 14:46
Copy link

github-actions bot commented Mar 19, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@adamyeats adamyeats changed the title Docs: Clarify some points in documentations and typedocs Docs: Clarify some points in documentation and typedocs Mar 19, 2024
@academo academo requested a review from sunker March 19, 2024 16:24
Copy link
Contributor

@sunker sunker left a comment

Choose a reason for hiding this comment

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

Thanks for raising this PR and many thanks for feedback @adamyeats! It's very appreciated.

The auth state mechanism is also described in the Authentication article, so I pushed a commit that adds the same comment to the snippets in this file.

@sunker sunker merged commit f786e08 into main Mar 22, 2024
20 checks passed
@sunker sunker deleted the adamyeats-docs-updates branch March 22, 2024 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants