Fix docstring that used example tag instead of exception (#415)

DanteDeRuwe · bchavez · web-flow · commit 5c830673f94d · 2022-03-20T21:02:20.000-06:00
* Fix docstring that used `example` tag instead of `exception`

* Change also Benchmark/BenchRandomSubset.cs

Co-authored-by: bchavez &lt;bchavez@bitarmory.com&gt;
diff --git a/Source/Benchmark/BenchRandomSubset.cs b/Source/Benchmark/BenchRandomSubset.cs
@@ -39,7 +39,7 @@ public void ShuffleTake()
         /// Helper to pick random subset of elements out of the list.
         /// </summary>
         /// <param name="amountToPick">amount of elements to pick of the list.</param>
-        /// <example cref="ArgumentException">if amountToPick is lower than zero.</example>
+        /// <exception cref="ArgumentException">if amountToPick is lower than zero.</example>
         public IEnumerable<T> PickRandom<T>(IEnumerable<T> items, int amountToPick)
         {
             if (amountToPick < 0)
diff --git a/Source/Bogus/Faker.cs b/Source/Bogus/Faker.cs
@@ -251,7 +251,7 @@ public T PickRandomParam<T>(params T[] items)
       /// Helper to pick random subset of elements out of the list.
       /// </summary>
       /// <param name="amountToPick">amount of elements to pick of the list.</param>
-      /// <example cref="ArgumentException">if amountToPick is lower than zero.</example>
+      /// <exception cref="ArgumentException">if amountToPick is lower than zero.</exception>
       public IEnumerable<T> PickRandom<T>(IEnumerable<T> items, int amountToPick)
       {
          if( amountToPick < 0 )

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public void ShuffleTake()`
`39`	`39`	`/// Helper to pick random subset of elements out of the list.`
`40`	`40`	`/// </summary>`
`41`	`41`	`/// <param name="amountToPick">amount of elements to pick of the list.</param>`
`42`		`- /// <example cref="ArgumentException">if amountToPick is lower than zero.</example>`
	`42`	`+ /// <exception cref="ArgumentException">if amountToPick is lower than zero.</example>`
`43`	`43`	`public IEnumerable<T> PickRandom<T>(IEnumerable<T> items, int amountToPick)`
`44`	`44`	`{`
`45`	`45`	`if (amountToPick < 0)`
Original file line number	Diff line number	Diff line change
`@@ -251,7 +251,7 @@ public T PickRandomParam<T>(params T[] items)`
`251`	`251`	`/// Helper to pick random subset of elements out of the list.`
`252`	`252`	`/// </summary>`
`253`	`253`	`/// <param name="amountToPick">amount of elements to pick of the list.</param>`
`254`		`- /// <example cref="ArgumentException">if amountToPick is lower than zero.</example>`
	`254`	`+ /// <exception cref="ArgumentException">if amountToPick is lower than zero.</exception>`
`255`	`255`	`public IEnumerable<T> PickRandom<T>(IEnumerable<T> items, int amountToPick)`
`256`	`256`	`{`
`257`	`257`	`if( amountToPick < 0 )`