From bba45420dbef20fb8c21aaef7f8b5dbb46491b31 Mon Sep 17 00:00:00 2001 From: Tino Hager Date: Tue, 5 Mar 2024 09:38:47 +0100 Subject: [PATCH] optimize documentation --- doc/README.md | 4 ++-- .../HolidayProviders/IPublicHolidayHolidayProvider.cs | 4 ++-- src/Nager.Date/WeekendProviders/IWeekendProvider.cs | 4 ++-- src/Nager.Date/readme.txt | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/README.md b/doc/README.md index f031b9c5..ff896eec 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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) @@ -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 } ``` diff --git a/src/Nager.Date/HolidayProviders/IPublicHolidayHolidayProvider.cs b/src/Nager.Date/HolidayProviders/IPublicHolidayHolidayProvider.cs index 91d8f119..ee6d9710 100644 --- a/src/Nager.Date/HolidayProviders/IPublicHolidayHolidayProvider.cs +++ b/src/Nager.Date/HolidayProviders/IPublicHolidayHolidayProvider.cs @@ -12,13 +12,13 @@ public interface IHolidayProvider /// Get Holidays of the given year /// /// - /// Set of public holidays for given year + /// Set of holidays for given year IEnumerable GetHolidays(int year); /// /// Get the Holiday Sources /// - /// Set of public holiday sources (links) + /// Set of holiday sources (links) IEnumerable GetSources(); } } diff --git a/src/Nager.Date/WeekendProviders/IWeekendProvider.cs b/src/Nager.Date/WeekendProviders/IWeekendProvider.cs index 5752e5b6..1c6c59d8 100644 --- a/src/Nager.Date/WeekendProviders/IWeekendProvider.cs +++ b/src/Nager.Date/WeekendProviders/IWeekendProvider.cs @@ -22,10 +22,10 @@ public interface IWeekendProvider bool IsWeekend(DateTime date); /// - /// Is given public holiday in the weekend + /// Is given holiday in the weekend /// /// - /// True if given public holiday is in the weekend, false otherwise + /// True if given holiday is in the weekend, false otherwise bool IsWeekend(Holiday publicHoliday); /// diff --git a/src/Nager.Date/readme.txt b/src/Nager.Date/readme.txt index e911e068..a5ea64e7 100644 --- a/src/Nager.Date/readme.txt +++ b/src/Nager.Date/readme.txt @@ -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 } @@ -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 }