Update Documentation for LookupMessages

[ThomasAunvik]

aboutAYear returns months, not years.

From day 365 and to 729.

If it was years, it would look like 12y to 24y

timeago.dart/packages/timeago/lib/src/timeago.dart

Line 99 in 9d5691d

result = messages.aboutAYear(months.round());

Example:

import 'package:timeago/timeago.dart' as timeago;

// my_custom_messages.dart
class MyCustomMessages implements timeago.LookupMessages {
  @override
  String prefixAgo() => '';
  @override
  String prefixFromNow() => '';
  @override
  String suffixAgo() => '';
  @override
  String suffixFromNow() => '';
  @override
  String lessThanOneMinute(int seconds) => 'now';
  @override
  String aboutAMinute(int minutes) => '${minutes}m';
  @override
  String minutes(int minutes) => '${minutes}m';
  @override
  String aboutAnHour(int minutes) => '${minutes}m';
  @override
  String hours(int hours) => '${hours}h';
  @override
  String aDay(int hours) => '${hours}h';
  @override
  String days(int days) => '${days}d';
  @override
  String aboutAMonth(int days) => '${days}d';
  @override
  String months(int months) => '${months}mo';
  @override
  String aboutAYear(int year) => '${year}y';
  @override
  String years(int years) => '${years}y';
  @override
  String wordSeparator() => ' ';
}

main() {
  // Override "en" locale messages with custom messages that are more precise and short
  timeago.setLocaleMessages('en', MyCustomMessages());

  final months = DateTime.now().subtract(Duration(days: 365));
  final month2 = DateTime.now().subtract(Duration(days: 729));

  print(timeago.format(months)); // 12y
  print(timeago.format(months2)); // 24y
}