[Zeitgeist-bugs] [Bug 62086] New: TimeRange.intersect name is cryptic

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=62086

          Priority: medium
            Bug ID: 62086
          Assignee: zeitgeist-bugs at lists.freedesktop.org
           Summary: TimeRange.intersect name is cryptic
        QA Contact: zeitgeist-bugs at lists.freedesktop.org
          Severity: normal
    Classification: Unclassified
                OS: All
          Reporter: manishsinha at ubuntu.com
          Hardware: Other
            Status: NEW
           Version: 0.9.x
         Component: libzeitgeist
           Product: Zeitgeist

libzeitgeist-2.0 has a new method in libzeitgeist-2.0

public TimeRange? intersect (TimeRange time_range)
Check whether two time ranges are intersecting.

OPTION1: 
Either the doc should be

"Find the intersection of two TimeRange. If two TimeRange don't intersect, then
null is returned"

OR OPTION2:

the method should be

public bool does_intersect (TimeRange time_range)

if you want to keep the documentation since the documentation for this method
starts with "Check whether....", when you check, it should return a boolean
value.

-----------------

I guess the first one makes sense.

-- 
You are receiving this mail because:
You are the QA Contact for the bug.
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/zeitgeist-bugs/attachments/20130310/a84b1061/attachment.html>