Bogus icon indicating copy to clipboard operation
Bogus copied to clipboard

No documentation for IndexFaker

Open acnicholls-kroll opened this issue 5 months ago • 2 comments

Bogus NuGet Package

35.6.3

.NET Version

Net 9.0

Visual Studio Version

17.14.7

What operating system are you using?

Windows

What locale are you using with Bogus?

en_US

Problem Description

Searching for IndexFaker on the main page of the readme.md brings up no results. a junior dev found it somehow and put it in a PR. I then did a google search for bogus faker IndexFaker and found this blog: https://juldhais.net/generating-random-dummy-data-using-bogus-e1f57eecf90b, which shows it's usage.

LINQPad Example or Reproduction Steps

no repro needed

Expected Behavior

important features like this are document

Actual Behavior

no behaviour identified

Known Workarounds

No response

Could you help with a pull-request?

No

acnicholls-kroll avatar Jul 02 '25 14:07 acnicholls-kroll

Documentation is basically the XML docs here: https://github.com/bchavez/Bogus/blob/4c2b15b3e7ddb20aefbcbafa35ba408d692a2d33/Source/Bogus/Faker.cs#L401-L405

but good first issue if someone wants to take it.

bchavez avatar Aug 03 '25 22:08 bchavez

nice. Since this is my work account, I'll review the issue with my personal one and fork the repo to submit a PR, unless someone else takes it first. I've learned how to use this property now, so it's fresh.

acnicholls-kroll avatar Aug 05 '25 13:08 acnicholls-kroll