Repository navigation
Docs: Document scanning a branch or tag with use_ref - #4461
Open
Anurag-S1ngh wants to merge 1 commit into
Open
Anurag-S1ngh wants to merge 1 commit into
Anurag-S1ngh wants to merge 1 commit into
Conversation
Scanning a named reference already works through DataScan.use_ref, but it was not documented, so the audit example looked up the snapshot id manually. Add a section for use_ref and use it in the example.
This branch has not been deployed
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.
Rationale for this change
Scanning a named branch or tag already works through
DataScan.use_ref, but it was not documented. The branching example looked up the ref's snapshot id and passed it toscan(snapshot_id=...), which made the feature hard to discover.Add a "Scanning a branch or tag" section and use
use_refin the audit example.Are these changes tested?
The docs build passes with
mkdocs build --strict.Are there any user-facing changes?
No code change. The documentation now describes how to scan a branch or tag.