Merge pull request #9 from ClydeDz/dev/1.0.0

Make comments consistent and simplify interpolation.

Src/Horoscope.TestConsole/ChineseZodiacExamples.cs

@@ -13,17 +13,17 @@ class ChineseZodiacExamples
         public static void ShowZodiacBasicExamples()
         {
             var allFireChineseSigns = ChineseZodiac.GetAllZodiacSignsForAnElement(ChineseZodiacElements.Fire);
-            Console.WriteLine($"\nGet a list of all Chinese zodiac signs that are associated with {ChineseZodiacElements.Fire.ToString()}");
+            Console.WriteLine($"\nGet a list of all Chinese zodiac signs that are associated with {ChineseZodiacElements.Fire}");
             foreach (var currentZodiacSign in allFireChineseSigns)
             {
                 Console.WriteLine($"-\t{currentZodiacSign.ZodiacEnglishTranslation}");
             }
 
             var dragonZodiacSign = ChineseZodiac.GetZodiacSign(ChineseZodiacSigns.Dragon);
-            Console.WriteLine($"\nPersonality trait for {ChineseZodiacSigns.Dragon.ToString()} people: {dragonZodiacSign.ZodiacPersonality}");
+            Console.WriteLine($"\nPersonality trait for {ChineseZodiacSigns.Dragon} people: {dragonZodiacSign.ZodiacPersonality}");
 
             var zodiacSignFor2018 = ChineseZodiac.GetChineseZodiacElementBasedOnYear(2018);
-            Console.WriteLine($"\nChinese zodiac element for 2018 is {zodiacSignFor2018.ToString()}");
+            Console.WriteLine($"\nChinese zodiac element for 2018 is {zodiacSignFor2018}");
 
             var zodiacSignForDate = ChineseZodiac.GetZodiacSignForDate(new DateTime(1966, 2, 12));
             Console.WriteLine($"\nChinese zodiac sign for {new DateTime(1966, 2, 12).ToShortDateString()} is {zodiacSignForDate.ZodiacEnglishTranslation}");

Src/Horoscope.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
   <metadata>
     <id>Horoscope</id>
-    <version>0.9.1</version>
+    <version>0.9.3</version>
     <title>Horoscope</title>
     <authors>Clyde D'Souza</authors>
     <owners>Clyde D'Souza</owners>

Src/Horoscope/ChineseZodiac.cs

@@ -37,7 +37,7 @@ public static ChineseZodiacModel GetZodiacSign(ChineseZodiacSigns requestedZodia
         /// <summary>
         /// Gets all zodiac signs and details for each sign.
         /// </summary>
-        /// <returns>List of zodiac signs each as a Zodiac sign object.</returns>
+        /// <returns>List of zodiac signs each as a zodiac sign object.</returns>
         public static List<ChineseZodiacModel> GetAllZodiacSigns()
         {
             return ChineseZodiacHelper.InitializeAndGetAllZodiacSigns().Values.ToList();

Src/Horoscope/Horoscope.csproj

@@ -5,7 +5,7 @@
     <Authors>Clyde D'Souza</Authors>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <PackageId>Horoscope</PackageId>
-    <Version>0.9.2</Version>
+    <Version>0.9.3</Version>
     <Company />
     <PackageLicenseUrl></PackageLicenseUrl>
     <RepositoryUrl>https://github.com/ClydeDz/horoscope-nuget</RepositoryUrl>
@@ -14,8 +14,8 @@
     <Description>A .NET library for zodiac signs. Get details on each zodiac sign, pass a date and know which zodiac sign it falls in or get a list of all zodiac signs. Now includes Chinese zodiac signs and elements!</Description>
     <Copyright>Copyright (c) 2018 Clyde D'Souza</Copyright>
     <PackageReleaseNotes>Now includes Chinese zodiac signs, fixed elements (i.e., wood, fire, earth, metal, water) and yin yang associated with each Chinese zodiac sign. More release notes here: https://github.com/ClydeDz/horoscope-nuget/releases</PackageReleaseNotes>
-    <AssemblyVersion>0.9.2.0</AssemblyVersion>
-    <FileVersion>0.9.2.0</FileVersion>
+    <AssemblyVersion>0.9.3.0</AssemblyVersion>
+    <FileVersion>0.9.3.0</FileVersion>
     <PackageIconUrl></PackageIconUrl>
     <Product>Horoscope</Product>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>

Src/Horoscope/Model/BaseZodiacModel.cs

@@ -1,7 +1,7 @@
 namespace Horoscope.Model
 {
     /// <summary>
-    /// Base Zodiac sign object containing information common to all Zodiac signs.
+    /// Base zodiac sign object containing information common to all zodiac signs.
     /// </summary>
     public class BaseZodiacModel
     {

Src/Horoscope/Model/ChineseZodiacModel.cs

@@ -1,5 +1,8 @@
 namespace Horoscope.Model
 {
+    /// <summary>
+    /// The Chinese zodiac sign object containing information on each Chinese zodiac sign.
+    /// </summary>
     public class ChineseZodiacModel: BaseZodiacModel
     {
         internal ChineseZodiacModel(string name, string english, string zodiacPersonality, ChineseZodiacElements chineseZodiacFixedElement, YinYang yinYang)

Src/Horoscope/Model/ZodiacModel.cs

@@ -1,7 +1,7 @@
 namespace Horoscope.Model
 {
     /// <summary>
-    /// The Zodiac sign object containing information on each Zodiac sign.
+    /// The zodiac sign object containing information on each zodiac sign.
     /// </summary>
     public class ZodiacModel: BaseZodiacModel
     {
@@ -13,7 +13,7 @@ internal ZodiacModel(string name, string english, ZodiacDateModel start, ZodiacD
         }
 
         /// <summary>
-        /// The duration for this Zodiac sign.
+        /// The duration for this zodiac sign.
         /// Example: December 22 to January 19.
         /// </summary>
         public string ZodiacDuration { get { return $"{ToMonth(ZodiacStartDate.Month)} {ZodiacStartDate.Date} to {ToMonth(ZodiacEndDate.Month)} {ZodiacEndDate.Date}"; } }