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

* Fix docstring that used `example` tag instead of `exception` * Change also Benchmark/BenchRandomSubset.cs Co-authored-by: bchavez <bchavez@bitarmory.com>
bchavez · Mar 21, 2022 · 5c83067 · 5c83067
1 parent 59985ee
commit 5c83067
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
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 )