Docs

Author: migueldeicaza

NStack/NStack.csproj

@@ -5,7 +5,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard1.5</TargetFramework>
     <PackageId>NStack.Core</PackageId>
-    <PackageVersion>0.7</PackageVersion>
+    <PackageVersion>0.8</PackageVersion>
     <Authors>Miguel de Icaza</Authors>
     <PackageLicenseUrl>https://github.com/migueldeicaza/NStack/blob/master/LICENSE.md</PackageLicenseUrl>
     <Owners>Miguel de Icaza</Owners>
@@ -19,7 +19,8 @@ It starts with a new string type that is focused on Unicode code-points as oppos
     <ReleaseVersion>0.3</ReleaseVersion>
     <PackageReleaseNotes>* Renamed some methods to match the equivalent methods in Char.
 * Introduced Substring (int start)
-* Introduced difference between this [int start, int end] and this [int start, object end] the latter used to mean "until the end", replacing '0' as the previous value for "until the end".</PackageReleaseNotes>
+* Introduced difference between this [int start, int end] and this [int start, object end] the latter used to mean "until the end", replacing '0' as the previous value for "until the end".
+* Introduced new method in Rune to measure the width in columns for console applications.</PackageReleaseNotes>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">

NStack/strings/ustring.cs

@@ -97,6 +97,7 @@ namespace NStack {
 	///   is exclusive.   Negative values can be used to index the string from the end.  See the documentation
 	///   for the indexer for more details.
 	/// </para>
+	/// 
 	/// </remarks>
 	public abstract class ustring : IComparable<ustring>, IComparable, IConvertible, IEnumerable<uint>, IEquatable<ustring>
 #if NETSTANDARD2_0
@@ -1700,7 +1701,19 @@ public static bool Contains (ref AsciiSet aset, byte b)
 		/// <returns>Enumerable object that can be used to iterate and get the index of the values at the same time.</returns>
 		/// <remarks>
 		/// This is useful to iterate over the string and obtain both the index of the rune and the rune
-		/// in the same call.  
+		/// in the same call.  This version does allocate an object for the enumerator, if you want to avoid
+		/// the object allocation, you can use the following code to iterate over the contents of the string
+		/// <example>
+		/// <code lang="c#">
+		///   ustring mystr = "hello";
+		///   int byteLen = mystr.Length;
+		///   for (int i = 0; i &lt; byteLen;) {
+		///       (var rune, var size) = Utf8.DecodeRune(mystr, i, i - byteLen);
+		///       Console.WriteLine ("Rune is: " + rune);
+		///       i += size;
+		///   }
+		/// </code>
+		/// </example>
 		/// </remarks>
 		public IEnumerable<(int index, uint rune)> Range ()
 		{