docs: correct the documented input for engine.gender() in README#243
Open
SAY-5 wants to merge 1 commit into
Open
docs: correct the documented input for engine.gender() in README#243SAY-5 wants to merge 1 commit into
engine.gender() in README#243SAY-5 wants to merge 1 commit into
Conversation
Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
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
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.
Addresses one of the issues in #116. The maintainer indicated in #116 (comment):
The README currently documents
gender()as taking the first letter of the gender:But
engine.gender()actually validates its argument againstsingular_pronoun_genders(inflect/__init__.pyline 1606), which only contains the full words"feminine","masculine","neuter","gender-neutral","feminine or masculine"and"masculine or feminine". Passing'f'raisesBadGenderError.This PR rewrites that paragraph to list the accepted values and use
gender("feminine")in the example, matching the existing working example at line 110 of the same README.Verified locally:
Unit tests pass (
pytest tests/: 207 passed, 16 xfailed). No source code is changed; this is documentation only.