Comments (7)
I like that there are instructions for every language, but sometimes want to remove unnecessary information, maybe README file for each language with links or wiki could be a nice approach.
from numbers_and_words.
I think the instructions in multiple languages is a nice addition, however as you mention the readme would quickly become a mess if it would include all the translations for every supported language (not to mention other problems, like hungarian is a highly inflected language, so you can't simply replace "compatible with" with the exact hungarian translation in "compatible with Ruby 1.9" because that wouldn't adhere to our grammar rules).
I think the readme should only include
- a quick description of the gem
- list of the supported languages and mentioning that they have separate documentation (and they may support extra options)
- examples in every language, but a bit more compact than currently. it's nice to showcase what is achievable, but this will only ever grow
- the other parts: requirements, installation, license, bugs and contacts
and only in english, further localized documentation should kept as separate not to clutter the readme. As languages will grow to have specific options it will make sense to move the documentation of these options to the documentation of the related languages (that support these options).
I'm not sure which format is better, the GH wiki is a convenient place, however with separate files (committed to the repo) the gem documentation could also include these.
from numbers_and_words.
I believe the list of languages and maybe 1 example should be in every single language, but everything else can be in English.
from numbers_and_words.
maybe we could have a few examples only in english (e.g. how to use the gem), but before that we could have a few numbers (possibly including fractional and other specific things to showcase) translated as the array example right now (e.g. a more terse translation of multiple numbers).
from numbers_and_words.
+1 for a readme in each language
from numbers_and_words.
@kslazarev: Could you enable the Wikis for this repo?
from numbers_and_words.
Wikis tend to quickly become obsolete and changes are free-for-all. Can we just add .md files to the repo in pull requests and link in READMEs?
from numbers_and_words.
Related Issues (20)
- This gem breaks pluralization
- Fork? HOT 12
- Finish German support
- Numeric Fallback HOT 5
- Wrong dependencies management makes the gem require activesupport 5.0 thus Ruby 2.2.2 HOT 8
- Drop EOL'ed Rubies in Travis CI HOT 1
- Configure I18n.available_locales
- Support for Arabic HOT 3
- Crashing Spanish Translations HOT 2
- Support for Chinese? HOT 1
- Support for float numbers in french HOT 1
- Floating-point numbers with five or more digits after decimal separator
- Move this gem into a github org?
- Ability to add units
- Why included .yml languages as internal instead of document them and let user customize? HOT 2
- Wrong precision 2 for spanish HOT 1
- I18n::InvalidPluralizationData (translation data {:one=>"tenth", :other=>"tenths"} HOT 7
- Incorrect joiner for some Dutch examples HOT 3
- Problem with hundreds as array HOT 1
- Does this gem work with Ruby 3.2.0 ? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from numbers_and_words.