docs: document IndexFaker usage#638
Open
YNan-varamor wants to merge 1 commit into
Open
Conversation
YNan-varamor
marked this pull request as ready for review
June 23, 2026 04:42
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a README section showing how to use
IndexFakerto derive values from the current generated-object index within aFaker<T>instance.Why
Fixes #610.
IndexFakeris documented in XML comments, but it is not discoverable from the main README. The new example places it near the existing generation examples and demonstrates a common cyclic assignment pattern.Validation
git diff --checkSource/Bogus/Faker.csXML documentation forIndexFakerUniquenessTests.should_be_able_to_drive_internal_indexNotes
This is a documentation-only change, so I did not run the full test suite.
AI assistance disclosure
This PR was prepared with assistance from OpenAI Codex. The change was reviewed locally and kept to a focused documentation update.