Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docstring that used example tag instead of exception #415

Merged
merged 2 commits into from
Mar 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Source/Benchmark/BenchRandomSubset.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion Source/Bogus/Faker.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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 )
Expand Down