Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 14, 2026

The documentation for register_correlation_hook in snapshooter.py was ambiguous about the hook's three parameters, making it unclear they were separate arguments rather than a single description.

Changes:

  • Updated docstring to explicitly list the three parameters: entity_type (str), current_values (dict, including linked entities), and master_record (dict)

Before:

hook: `hook` callable should expect entity type as str
    and its current values, including linked entities, as dict;
    and its master record as dict.

After:

hook: `hook` callable should expect three parameters:
    entity_type (str), current_values (dict, including linked entities),
    and master_record (dict).

This aligns with the actual function signature: Callable[[str, dict, dict], Union[None, list[DataPointTask]]]


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: xsedla1o <62329066+xsedla1o@users.noreply.github.com>
Copilot AI changed the title [WIP] WIP address feedback on correlation hook implementation Clarify correlation hook parameter documentation Jan 14, 2026
Copilot AI requested a review from xsedla1o January 14, 2026 09:26
@xsedla1o xsedla1o closed this Jan 14, 2026
@xsedla1o xsedla1o deleted the copilot/sub-pr-32 branch January 14, 2026 11:47
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.

2 participants