jqueguiner / num2words2 / 25220084867

95%

master: 94%

push

github

docs: add comprehensive REFERENCE.md + refresh README (#118)

* docs: add comprehensive REFERENCE.md + refresh README

Adds a single-page API reference covering every feature shipped
through v1.0.17 in one discoverable place:

  - All conversion modes (cardinal, ordinal, ordinal_num, year,
    currency including 3-decimal mils, cheque, fraction)
  - Per-call options (style=, precision=, cents=, spaced=,
    decimal_word=, gender=, case=)
  - Aviation/ICAO subsystem: ICAO/FAA/USN/US_Army/NATO profiles
    plus to_altitude / to_flight_level / to_heading / to_squawk
    / to_runway / to_frequency
  - Utility helpers: maxval(), group_digits(), num2words_sentence()
  - Locale codes: highlights of the 170+ registered keys grouped
    by region, plus the alias table
  - String input semantics (fraction routing, Decimal precision,
    mixed-text fallback)
  - Per-feature migration notes (string fractions, TR natural-precision
    floats)

README updates:
  - Replace stale '50+ languages' references with '120+ languages
    (170+ locale codes)' to match the actual registry
  - Pointer to REFERENCE.md from the intro and Usage sections
  - New examples in Usage covering fractions, cheque format,
    3-decimal currencies, aviation, gender/case kwargs
  - Replace the ~50-entry language list with a regionally-grouped
    overview that ends in a link to REFERENCE.md → Locale codes

The README.rst (PyPI canonical) is untouched in this commit; it can
follow up separately if needed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(badges): point all badges at jqueguiner/num2words2 + auto-update

Stale-badge fixes called out by the user:

- README.rst CI badge → wrong repo (num2words instead of num2words2)
- README.rst coveralls badge → wrong repo + wrong branch (master vs main)
- README_num2words2.md missed CI / coverage badges entirely
- All shields/coveralls URLs now use github/jqueguiner/num2words2 + branch=main
- README.rst badge URL st... (continued)

8042 of 8834 branches covered (91.03%)

Branch coverage included in aggregate %.

42430 of 44184 relevant lines covered (96.03%)

5.76 hits per line