Add a footnote explain leap years
authorMatthias Clasen <matthiasc@src.gnome.org>
Sat, 10 Nov 2007 01:56:13 +0000 (01:56 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sat, 10 Nov 2007 01:56:13 +0000 (01:56 +0000)
svn path=/trunk/; revision=5854

docs/reference/ChangeLog
docs/reference/glib/tmpl/date.sgml

index 7f63a25..f2ba34f 100644 (file)
@@ -1,5 +1,8 @@
 2007-11-09  Matthias Clasen <mclasen@redhat.com>
 
+       * glib/tmpl/date.sgml: Add a footnote explaining leap years.
+       (#491982, Areg Beketovski)
+
        * glib/tmpl/date.sgml: Improve g_date_clamp docs.  (#491970,
        Areg Beketovski)
 
index f7a6dff..3af4e9d 100644 (file)
@@ -617,7 +617,10 @@ Returns %TRUE if the date is the last day of the month. The date must be valid.
 
 <!-- ##### FUNCTION g_date_is_leap_year ##### -->
 <para>
-Returns %TRUE if the year is a leap year.
+Returns %TRUE if the year is a leap year.<footnote><para>
+For the purposes of this function, leap year is every year divisible by
+4 unless that year is divisible by 100. If it is divisible by 100 it would 
+be a leap year only if that year is also divisible by 400.</para></footnote>
 </para>
 
 @year: year to check