Code review comment for lp:~zeitgeist/zeitgeist/find_events
Revision history for this message
| Mikkel Kamstrup Erlandsen (kamstrup) wrote | # |
review:
Needs Fixing
(code review)
© 2004
Canonical Ltd.
•
Terms of use
•
Data privacy
•
Contact Launchpad Support
•
Blog
•
Careers
•
System status
•
bbfa235
(Get the code!)
I am ok with this in theory, but I have a few comments regarding the code:
1. Can you please fully document FindEvents() with Sphinx markup?
2. I don't like calling our method find_eventids() and then returning Event instances... And using a method argument to control the return type seems non-standard to me. The engine is semi-public API because we have extensions so I think we should strive to keep it clean. I suggest we have to public methods find_events() and find_event_ids().
3. The docs for FindEventIds() should explain its purpose (large result sets - keeping ordering) and cross ref FIndEvents()
4. Can we have the ZeitgeistClient methods implemented and documented before the merge also?