Skip to content

Commit

Permalink
optimize documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tinohager committed Mar 5, 2024
1 parent 7663de7 commit bba4542
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The list of supported countries can be found [here](https://date.nager.at/Countr

## Examples

### Get all publicHolidays of a country and year
### Get all holidays of a country and year
```cs
var holidays = HolidaySystem.GetHolidays(2024, "DE");
foreach (var holiday in holidays)
Expand All @@ -17,7 +17,7 @@ foreach (var holiday in holidays)
//holiday.LocalName -> The local name
//holiday.EnglishName -> The english name
//holiday.NationalHoliday -> Is this holiday in every county (federal state)
//holiday.SubdivisionCodes -> Is the public holiday only valid for a special county ISO-3166-2 - Federal states
//holiday.SubdivisionCodes -> Is the holiday only valid for a special county ISO-3166-2 - Federal states
//holiday.HolidayTypes -> Public, Bank, School, Authorities, Optional, Observance
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ public interface IHolidayProvider
/// Get Holidays of the given year
/// </summary>
/// <param name="year"></param>
/// <returns>Set of public holidays for given year</returns>
/// <returns>Set of holidays for given year</returns>
IEnumerable<Holiday> GetHolidays(int year);

/// <summary>
/// Get the Holiday Sources
/// </summary>
/// <returns>Set of public holiday sources (links)</returns>
/// <returns>Set of holiday sources (links)</returns>
IEnumerable<string> GetSources();
}
}
4 changes: 2 additions & 2 deletions src/Nager.Date/WeekendProviders/IWeekendProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ public interface IWeekendProvider
bool IsWeekend(DateTime date);

/// <summary>
/// Is given public holiday in the weekend
/// Is given holiday in the weekend
/// </summary>
/// <param name="publicHoliday"></param>
/// <returns>True if given public holiday is in the weekend, false otherwise</returns>
/// <returns>True if given holiday is in the weekend, false otherwise</returns>
bool IsWeekend(Holiday publicHoliday);

/// <summary>
Expand Down
8 changes: 4 additions & 4 deletions src/Nager.Date/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Get all holidays of a specific year and country
//holiday.Date -> The date
//holiday.LocalName -> The local name
//holiday.EnglishName -> The english name
//holiday.NationalHoliday -> Is this public holiday in every county (federal state)
//holiday.SubdivisionCodes -> Is the public holiday only valid for a special county ISO-3166-2 - Federal states
//holiday.NationalHoliday -> Is this holiday in every county (federal state)
//holiday.SubdivisionCodes -> Is the holiday only valid for a special county ISO-3166-2 - Federal states
//holiday.HolidayTypes -> Public, Bank, School, Authorities, Optional, Observance
}

Expand All @@ -54,7 +54,7 @@ Get all holidays for a date range
//holiday.Date -> The date
//holiday.LocalName -> The local name
//holiday.EnglishName -> The english name
//holiday.NationalHoliday -> Is this public holiday in every county (federal state)
//holiday.SubdivisionCodes -> Is the public holiday only valid for a special county ISO-3166-2 - Federal states
//holiday.NationalHoliday -> Is this holiday in every county (federal state)
//holiday.SubdivisionCodes -> Is the holiday only valid for a special county ISO-3166-2 - Federal states
//holiday.HolidayTypes -> Public, Bank, School, Authorities, Optional, Observance
}

0 comments on commit bba4542

Please sign in to comment.