Register greet function with the worker

[chrisguidry]

No description provided.

[claude]

Claude finished @chrisguidry's task —— View job

---

PR Review: Register greet function with the worker

Review Checklist

• Examine the code changes
• Analyze alignment with PR title
• Check for code quality and best practices
• Identify potential bugs or issues
• Consider performance implications
• Review security aspects
• Assess test coverage impact

Review Summary

This PR adds a single line worker.register(greet) to the README.md example code. After careful review, I've identified a critical issue that makes this change incorrect.

🔴 Critical Issue

The added line worker.register(greet) in README.md:36 is unnecessary and misleading:

1. The greet function is already registered via docket.add(greet) on line 24 and 28
2. Workers automatically discover tasks that have been added to the Docket instance - explicit registration is not needed
3. This creates confusion about the proper usage pattern of the library

Analysis

Looking at the example flow:

• Lines 19-20: Define the greet async function
• Line 24: Schedule immediate execution with docket.add(greet)("Jane")
• Line 28: Schedule delayed execution with docket.add(greet, when=soon)("John", greeting="Howdy")
• Lines 35-37: Worker runs and processes the scheduled tasks

The Worker class is designed to automatically process tasks that have been scheduled through the Docket instance. Adding an explicit worker.register(greet) call suggests that manual registration is required, which contradicts the library's design pattern.

Recommendation

❌ This change should NOT be merged. The example code works correctly without this addition. The PR title "Register greet function with the worker" indicates a misunderstanding of how Docket's task scheduling works.

Correct Usage Pattern

Tasks are registered with Docket (not Worker) via:

• docket.add(task_function) for scheduling
• @docket.task decorator for registration

Workers automatically process any tasks that have been scheduled through their associated Docket instance.

Additional Notes

• Documentation Impact: This change would make the README example incorrect and potentially confuse new users
• No test coverage needed: This is a documentation-only change, but it introduces incorrect information
• No security/performance concerns: As this is just documentation

If the intent was to demonstrate explicit task registration for workers, that would require showing the @docket.task decorator pattern or using docket.register(), not worker.register().

[github-actions]

📚 Documentation has been built for this PR!

You can download the documentation directly here:
https://github.com/chrisguidry/docket/actions/runs/18728813363/artifacts/4344759029

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1eec4a7) to head (0955288).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #169   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           33        33           
  Lines         4820      4820           
  Branches       267       267           
=========================================
  Hits          4820      4820           

Flag	Coverage Δ
python-3.12	100.00% <ø> (ø)
python-3.13	100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.