Merge pull request #44 from meokullu/parameters_consistency_0001

meokullu · web-flow · commit 0faaf065563c · 2024-09-19T18:45:52.000+03:00
v2.3.0 #41 Parameters naming.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,11 @@
 #### Removed
 -->
 
+### [2.3.0]
+#### Changed
+* Parameter names on `PreFillCustom(string text, int maxLength, string stringValue = " ")` changed into `PreFillCustom(string context, int maxLength, string text = " ")` [#41](https://github.com/meokullu/PreFill/issues/40)
+* Parameter names on `PreFillCustom(string text, int maxLength, char charValue = ' ')` changed into `PreFillCustom(string context, int maxLength, char text = ' ')` [#41](https://github.com/meokullu/PreFill/issues/40)
+
 ### [2.2.2]
 #### Changed
 * Removed unused usings.
diff --git a/PreFill/Prefill.csproj b/PreFill/Prefill.csproj
@@ -5,9 +5,9 @@
     <ProduceReferenceAssembly>True</ProduceReferenceAssembly>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
-    <Version>2.2.3</Version>
-    <AssemblyVersion>2.2.3</AssemblyVersion>
-    <FileVersion>2.2.3</FileVersion>
+    <Version>2.3.0</Version>
+    <AssemblyVersion>2.3.0</AssemblyVersion>
+    <FileVersion>2.3.0</FileVersion>
     <Copyright>Enes Okullu</Copyright>
     <Description>PreFill is a project to align horizontally listed output values to right side in order to increase their legibility.</Description>
     <Title>PreFill</Title>
@@ -16,10 +16,10 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>data-science; data; data-engineering; alignment; data-analysis; egibility</PackageTags>
     <PackageReleaseNotes>
-      v.2.2.3
-      *
-      See changelog (https://github.com/meokullu/PreFill/blob/master/CHANGELOG.md)
-    </PackageReleaseNotes>
+		v2.3.0
+		* Parameter names changed on `PreFillCustom(string text, int maxLength, string stringValue = " ")` and `PreFillCustom(string text, int maxLength, char charValue = ' ')`. First parameter named as context and third value names and text. [#41](https://github.com/meokullu/PreFill/issues/40)
+		See changelog (https://github.com/meokullu/PreFill/blob/master/CHANGELOG.md)
+	</PackageReleaseNotes>
     <SignAssembly>False</SignAssembly>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
diff --git a/PreFill/src/PreFill.cs b/PreFill/src/PreFill.cs
@@ -136,33 +136,33 @@ public static string PreFillCustom(long number, int maxDigit, char text = ' ')
         /// <summary>
         /// Calculates length of given text then creates string with prefilling value of specified character before given numtextber on limit of maximum length.
         /// </summary>
-        /// <param name="text">A text whose prefill value to be found.</param>
+        /// <param name="context">A text whose prefill value to be found.</param>
         /// <param name="maxLength">Maximum length of context including specified number and prefilling.</param>
-        /// <param name="stringValue">Specified text whose will be used for prefilling.</param>
+        /// <param name="text">Specified text whose will be used for prefilling.</param>
         /// <returns>Returns prefill value for specified text.</returns>
-        public static string PreFillCustom(string text, int maxLength, string stringValue = " ")
+        public static string PreFillCustom(string context, int maxLength, string text = " ")
         {
             // Getting length of given text.
-            int textLength = maxLength - GetLengthOfString(text);
+            int textLength = maxLength - GetLengthOfString(context);
 
             // Calling FillString method to get prefilling value.
-            return FillString(textLength, stringValue);
+            return FillString(textLength, text);
         }
 
         /// <summary>
         /// Calculates length of given text then creates string with prefilling value of specified character before given numtextber on limit of maximum length.
         /// </summary>
-        /// <param name="text">A text whose prefill value to be found.</param>
+        /// <param name="context">A text whose prefill value to be found.</param>
         /// <param name="maxLength">Maximum length of context including specified number and prefilling.</param>
-        /// <param name="charValue">Specified character whose will be used for prefilling.</param>
+        /// <param name="text">Specified character whose will be used for prefilling.</param>
         /// <returns>Returns prefill value for specified text.</returns>
-        public static string PreFillCustom(string text, int maxLength, char charValue = ' ')
+        public static string PreFillCustom(string context, int maxLength, char text = ' ')
         {
             // Getting length of given text.
-            int textLength = maxLength - GetLengthOfString(text);
+            int textLength = maxLength - GetLengthOfString(context);
 
             // Calling FillChar method to get prefilling value.
-            return FillChar(textLength, charValue);
+            return FillChar(textLength, text);
         }
 
         /// <summary>
