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

Document that this is for English only #209

Closed
sveinbjornt opened this issue Apr 2, 2024 · 2 comments
Closed

Document that this is for English only #209

sveinbjornt opened this issue Apr 2, 2024 · 2 comments

Comments

@sveinbjornt
Copy link

Neither the summary nor the README explicitly specifies that this is for English only. Would be helpful to clarify this in the documentation as there are many, many other languages in the world!

@jaraco
Copy link
Owner

jaraco commented Apr 23, 2024

That seems reasonable. Would you be interested in drafting the change?

@joshstephenson
Copy link
Contributor

I'm happy to do that if you would like. It sounds like the kind of thing that belongs at the top of the README, under NAME. Perhaps...

Instead of this:
inflect.py - Correctly generate plurals, singular nouns, ordinals, indefinite articles; convert numbers to words.

How about this:
inflect.py - Accurately generate plurals, singular nouns, ordinals, indefinite articles, and word-based representations of numbers. This functionality is limited to English.

  • I find that "accurate" sounds better than "correct" because correct should be a given.
  • I removed the semicolon because after adding the disclaimer it would lead to ambiguity.
  • I changed "convert numbers to words" to "word-based representations of numbers" so it flows naturally from "accurately generate...word-based representations of numbers." Another option here would be "number representations" but I like the clarity of the first option.

I hope this is satisfactory. Let me know if you'd like a PR with this change.

@jaraco jaraco closed this as completed in d7dce0c Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants