Skip to content

Docs: Document scanning a branch or tag with use_ref - #4461

Open
Anurag-S1ngh wants to merge 1 commit into
apache:mainfrom
Anurag-S1ngh:docs/1746-scan-branch-ref
Open

Anurag-S1ngh wants to merge 1 commit into
apache:mainfrom
Anurag-S1ngh:docs/1746-scan-branch-ref

Conversation

@Anurag-S1ngh

Copy link
Copy Markdown
Contributor

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 to scan(snapshot_id=...), which made the feature hard to discover.

Add a "Scanning a branch or tag" section and use use_ref in 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.

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

No deployments
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