Skip to content
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

Correct documentation for Date.match() #1773

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Correct documentation for Date.match() #1773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 14 additions & 6 deletions gramps/gen/lib/date.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,12 @@ class Date:
The core date handling class for Gramps.

Supports partial dates, compound dates and alternate calendars.
Create a new Date instance using one of the following:
Date() - an empty (invalid) date
Date( other_date ) - duplicate another Date
Date( year ) - create an exact date - 1st Jan of the specified year
Date( year, month ) - create an exact date - 1st of the given month, year
Date( year, month, day ) - create an exact date
"""

MOD_NONE = 0 # CODE
Expand Down Expand Up @@ -1035,12 +1041,12 @@ def match(self, other_date, comparison="="):
Comparison Returns
========== =======================================================
=,== True if any part of other_date matches any part of self
< True if any part of other_date < any part of self
<= True if any part of other_date <= any part of self
<< True if all parts of other_date < all parts of self
> True if any part of other_date > any part of self
>= True if any part of other_date >= any part of self
>> True if all parts of other_date > all parts of self
< True if any part of self < any part of other_date
<= True if any part of self <= any part of other_date
<< True if all parts of self < all parts of other_date
> True if any part of self > any part of other_date
>= True if any part of self >= any part of other_date
>> True if all parts of self > all parts of other_date
========== =======================================================
"""
if (
Expand Down Expand Up @@ -1475,6 +1481,7 @@ def __set_yr_mon_day_offset(self, year, month, day, pos_yr, pos_mon, pos_day):
def set_yr_mon_day_offset(self, year=0, month=0, day=0):
"""
Offset the date by the given year, month, and day values.
If the source is a compound date then both are offset.
"""
if self.__set_yr_mon_day_offset(
year, month, day, Date._POS_YR, Date._POS_MON, Date._POS_DAY
Expand All @@ -1498,6 +1505,7 @@ def set2_yr_mon_day_offset(self, year=0, month=0, day=0):
def copy_offset_ymd(self, year=0, month=0, day=0):
"""
Return a Date copy based on year, month, and day offset.
If the source is a compound date then both are offset.
"""
orig_cal = self.calendar
if self.calendar != 0:
Expand Down
Loading