Skip to content

Commit c02ef50

Browse files
reorganize news (#304)
1 parent 3161d2e commit c02ef50

1 file changed

Lines changed: 21 additions & 14 deletions

File tree

NEWS.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
11
# potools 0.2.3 (in development)
22

3-
* [Feature] `translate_package()` has been made more modular by splitting up its steps into individual exported functions. Thanks @hadley for the suggestion & design review, in addition to the effort filing PRs to achieve this.
3+
## New features
4+
5+
* To encourage a more modular workflow, `translate_package()` has been split into individual exported functions. Thanks @hadley for the suggestion & design review, in addition to the effort filing PRs to achieve this.
46
+ `po_extract()` extracts messages from package source code to create template `.pot` files (@hadley, [#243](https://github.com/MichaelChirico/potools/pull/243)).
57
+ `po_create()` creates skeletal `.po` files for a given language from the `.pot` template (@hadley, [#235](https://github.com/MichaelChirico/potools/pull/235))
68
+ `po_compile()` converts `.po` translation files into binary `.mo` files used for installation (@hadley, [#234](https://github.com/MichaelChirico/potools/pull/234)).
79
+ `po_update()` incorporates and merges source message changes to existing `.po` files (@hadley, [#235](https://github.com/MichaelChirico/potools/pull/235))
8-
* [Note] `potools` now has a site built by [`pkgdown`](https://github.com/r-lib/pkgdown) and hosted on GitHub pages: https://michaelchirico.github.io/potools/. Thanks @hadley for the initial implementation.
9-
* [Documentation] Two new vignettes, ["Translation for package developers"](https://michaelchirico.github.io/potools/articles/developers.html) and ["Translation for package translators"](https://michaelchirico.github.io/potools/articles/translators.html) explain in some detail the process of translation from two perspectives -- that of the package developer and that of the message translator.
10-
* [Bugfix] `translate_package()` works in batch mode, [#224](https://github.com/MichaelChirico/potools/issues/224). Thanks @HenrikBengtsson for the report.
11-
* potools has a new hex logo! Thanks to @hadley for coordinating and @allisonhorst for the drawing!
12-
* [Bugfix] `check_cracked_messages()` recognizes named arguments (e.g. `call.` to `stop()` or `appendLF` to `message()`) and keeps them in the original call, [#227](https://github.com/MichaelChirico/potools/issues/227). Thanks @hadley for the report.
13-
* [Note] The test suite now relies on the 3rd edition of `testthat`, meaning a version requirement in the Suggested dependency.
14-
* [Note] The default value of `verbose` has been changed to `TRUE` in `translate_package()` and `get_message_data()`. Verbosity has also been increased to help detect the source of issues, [#288](https://github.com/MichaelChirico/potools/issues/288). Thanks for @LDalby for reporting an unhelpful error.
15-
* [Note] The package now contains Japanese translations of `potools` itself to serve as an example. See [po/R-ja.po](po/R-ja.po). [#241](https://github.com/MichaelChirico/potools/issues/241); thanks @HenrikBengtsson for the suggestion.
16-
* [Feature] `check_potools_sys_reqs()` (mostly intended for internal use, but exported for testing) gains a `which` argument to fine-tune which system requirements to check, [#275](https://github.com/MichaelChirico/potools/issues/275) and [#288](https://github.com/MichaelChirico/potools/issues/288). Thanks @hadley for the suggestion and @LDalby for early dev testing which emphasized the need for this.
17-
* [Note] potools gains a logo featuring a [potoo](https://en.wikipedia.org/wiki/Potoo) thanks to the artistic skills of @allisonhorst
18-
* [Feature] New function `po_explain_plurals()` to help de-mystify how to supply plurals for different languages. For example, `po_explain_plurals("pl", 3)` explains that "For Polish (Polski), plural index 2 applies when n = 0, 5-21, 25-31, 35-41, ...", [#278](https://github.com/MichaelChirico/potools/issues/278). Thanks @hadley for the suggestion to independently export this functionality which was already used as part of `translate_package()`.
19-
* [Bugfix] A test for non-GNU versions of `gettext` has been improved, [#221](https://github.com/MichaelChirico/potools/issues/221). Please report any issues here -- I don't have any good way of testing non-GNU tools.
20-
* [Bugfix] .po files generated by {potools} will default to using `charset=UTF-8`, not `charset=ASCII`, to prevent encoding issues (@michaelchirico, [#299](https://github.com/MichaelChirico/potools/issues/299)). Thanks @maelle for the report!
10+
* Two new vignettes, ["Translation for package developers"](https://michaelchirico.github.io/potools/articles/developers.html) and ["Translation for package translators"](https://michaelchirico.github.io/potools/articles/translators.html) explain in some detail the process of translation from two perspectives -- that of the package developer and that of the message translator.
11+
* `check_potools_sys_reqs()` (mostly intended for internal use, but exported for testing) gains a `which` argument to fine-tune which system requirements to check, [#275](https://github.com/MichaelChirico/potools/issues/275) and [#288](https://github.com/MichaelChirico/potools/issues/288). Thanks @hadley for the suggestion and @LDalby for early dev testing which emphasized the need for this.
12+
* New `po_explain_plurals()` helps de-mystify how to supply plurals for different languages. For example, `po_explain_plurals("pl", 3)` explains that "For Polish (Polski), plural index 2 applies when n = 0, 5-21, 25-31, 35-41, ...", [#278](https://github.com/MichaelChirico/potools/issues/278). Thanks @hadley for the suggestion to independently export this functionality which was already used as part of `translate_package()`.
13+
14+
## Bug fixes
15+
16+
* `translate_package()` works in batch mode, [#224](https://github.com/MichaelChirico/potools/issues/224). Thanks @HenrikBengtsson for the report.
17+
* `check_cracked_messages()` recognizes named arguments (e.g. `call.` to `stop()` or `appendLF` to `message()`) and keeps them in the original call, [#227](https://github.com/MichaelChirico/potools/issues/227). Thanks @hadley for the report.
18+
* A test for non-GNU versions of `gettext` has been improved, [#221](https://github.com/MichaelChirico/potools/issues/221). Please report any issues here -- I don't have any good way of testing non-GNU tools.
19+
* .po files generated by {potools} will default to using `charset=UTF-8`, not `charset=ASCII`, to prevent encoding issues (@michaelchirico, [#299](https://github.com/MichaelChirico/potools/issues/299)). Thanks @maelle for the report!
20+
21+
## Notes
22+
23+
* {potools} now has a site built by [`pkgdown`](https://github.com/r-lib/pkgdown) and hosted on GitHub pages: https://michaelchirico.github.io/potools/. Thanks @hadley for the initial implementation.
24+
* {potools} has a new hex logo featuring a [potoo](https://en.wikipedia.org/wiki/Potoo)! Thanks to @hadley for coordinating and @allisonhorst for the drawing!
25+
* The test suite now relies on the 3rd edition of `testthat`, meaning a version requirement in the Suggested dependency.
26+
* The default value of `verbose` has been changed to `TRUE` in `translate_package()` and `get_message_data()`. Verbosity has also been increased to help detect the source of issues, [#288](https://github.com/MichaelChirico/potools/issues/288). Thanks for @LDalby for reporting an unhelpful error.
27+
* The package now contains Japanese translations of `potools` itself to serve as an example. See [po/R-ja.po](po/R-ja.po). [#241](https://github.com/MichaelChirico/potools/issues/241); thanks @HenrikBengtsson for the suggestion.
2128

2229
## New languages/locales supported out of the box:
2330

0 commit comments

Comments
 (0)