Skip to content

Clarify correlation hook parameter documentation #34

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.

Sign up for GitHub

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

Closed
Copilot wants to merge 2 commits into from
Closed

Clarify correlation hook parameter documentation #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81134b8
Initial plan
Copilot Jan 14, 2026
596c863
Docs: clarify correlation hook parameters in documentation
Copilot Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions dp3/snapshots/snapshooter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,9 @@ def register_correlation_hook(
`entity_type` and attribute specifications are validated, `ValueError` is raised on failure.

Args:
hook: `hook` callable should expect entity type as str
and its current values, including linked entities, as dict;
and its master record as dict.
hook: `hook` callable should expect three parameters:
entity_type (str), current_values (dict, including linked entities),
and master_record (dict).
Can optionally return a list of DataPointTask objects to perform.
entity_type: specifies entity type
depends_on: each item should specify an attribute that is depended on
Expand Down