No documentation for IndexFaker
- Dominant language
- C#
- Stars
- 9.7k
- Forks
- 538
- PR merge metrics
- No merged PRs in 30d
Description
### 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
Contributor guide
Research direction
Start by locating the IndexFaker API and the main readme.md, then compare the existing README coverage with the usage shown in the linked blog post. Done means the README documents IndexFaker clearly enough for a junior developer to discover and use it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100