Skip to content

Commit 4aded1b

Browse files
daniel-jones-devdaniel-jones-dev
committed
docs: changelog formatting
1 parent 145cf1e commit 4aded1b

File tree

1 file changed

+63
-79
lines changed

1 file changed

+63
-79
lines changed

‎CHANGELOG.md‎

Lines changed: 63 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -5,215 +5,201 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8-
98
### Added
10-
* Added `extraRequestParameters` option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as `target_lang`, `source_lang`, etc.).
9+
- Added `extraRequestParameters` option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as `target_lang`, `source_lang`, etc.).
1110

1211
## [1.12.0] - 2025-04-25
1312
### Added
14-
* Added support for the /v3 Multilingual Glossary APIs in the client library
15-
while providing backwards compatability for the previous /v2 Glossary
16-
endpoints. Please refer to the README or
13+
- Added support for the /v3 Multilingual Glossary APIs in the client library
14+
while providing backwards compatability for the previous /v2 Glossary
15+
endpoints. Please refer to the README or
1716
[upgrading_to_multilingual_glossaries.md](upgrading_to_multilingual_glossaries.md)
1817
for usage instructions.
1918

2019
## [1.11.1] - 2025-01-17
2120
### Fixed
22-
* Fixed `DeepLClientOptions` wrongly inheriting from `TranslateTextOptions`,
21+
- Fixed `DeepLClientOptions` wrongly inheriting from `TranslateTextOptions`,
2322
when it should be `TranslatorOptions`.
2423
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for the
2524
[report](https://github.com/DeepLcom/deepl-php/issues/59)
2625

27-
2826
## [1.11.0] - 2025-01-16
2927
### Added
30-
* Added support for the Write API in the client library, the implementation
28+
- Added support for the Write API in the client library, the implementation
3129
can be found in the `DeepLClient` class. Please refer to the README for usage
3230
instructions.
31+
3332
### Changed
34-
* The main functionality of the library is now also exposed via the `DeepLClient`
33+
- The main functionality of the library is now also exposed via the `DeepLClient`
3534
class. Please change your code to use this over the `Translator` class whenever
3635
convenient.
3736

38-
3937
## [1.10.1] - 2024-11-29
4038
### Fixed
41-
* Fixed the `TextResult` constructor to be compatible with pre-1.10 versions, to
39+
- Fixed the `TextResult` constructor to be compatible with pre-1.10 versions, to
4240
facilitate mocking
4341
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for
4442
[#56](https://github.com/DeepLcom/deepl-php/pull/56)
45-
* Fixed a bug when generating the platform information with `php_uname`.
43+
- Fixed a bug when generating the platform information with `php_uname`.
4644
* Thanks to [jochensengier](https://github.com/jochensengier) for
4745
[#57](https://github.com/DeepLcom/deepl-php/pull/57) and
4846
[that-guy-iain](https://github.com/that-guy-iain) +
4947
[jimwins](https://github.com/jimwins) for the
5048
[report](https://github.com/DeepLcom/deepl-php/issues/54).
5149

52-
5350
## [1.10.0] - 2024-11-15
5451
### Added
55-
* Added `MODEL_TYPE` option to `translateText()` to use models with higher
52+
- Added `MODEL_TYPE` option to `translateText()` to use models with higher
5653
translation quality (available for some language pairs), or better latency.
5754
Options are `'quality_optimized'`, `'latency_optimized'`, and `'prefer_quality_optimized'`
58-
* Added the `$modelTypeUsed` field to `translateText()` response, that
55+
- Added the `$modelTypeUsed` field to `translateText()` response, that
5956
indicates the translation model used when the `MODEL_TYPE` option is
6057
specified.
6158

62-
6359
## [1.9.0] - 2024-09-17
6460
### Added
65-
* Added `$billedCharacters` to the translate text response.
66-
61+
- Added `$billedCharacters` to the translate text response.
6762

6863
## [1.8.0] - 2024-06-24
6964
### Added
70-
* Added document minification as a feature before document translation, to allow
71-
translation of large `docx` or `pptx` files. For more info check the README.
72-
65+
- Added document minification as a feature before document translation, to allow
66+
translation of large `docx` or `pptx` files. For more info check the README.
7367

7468
## [1.7.2] - 2024-04-24
7569
### Fixed
76-
* Added a workaround for rare cases that the DeepL API responds with invalid
77-
UTF-8 sequences. In these cases the [replacement character][replacement-char]
70+
- Added a workaround for rare cases that the DeepL API responds with invalid
71+
UTF-8 sequences. In these cases the
72+
[replacement character](https://en.wikipedia.org/wiki/Replacement_character)
7873
"�" (U+FFFD) will replace invalid sequences.
79-
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for
74+
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for
8075
[#43](https://github.com/DeepLcom/deepl-php/pull/43)
8176

82-
8377
## [1.7.1] - 2024-02-28
8478
### Fixed
85-
* Update `VERSION` values to 1.7.1
86-
79+
- Update `VERSION` values to 1.7.1
8780

8881
## [1.7.0] - 2024-02-27
8982
### Added
90-
* New language available: Arabic (`'ar'`). Add language code constants and tests.
83+
- New language available: Arabic (`'ar'`). Add language code constants and tests.
9184
Arabic is currently supported only for text translation; document translation
9285
support for Arabic is coming soon.
9386

9487
Note: older library versions also support the new language, this update only adds new code constants.
88+
9589
### Fixed
96-
* Improve type of `translateText` function in `Translator`
90+
- Improve type of `translateText` function in `Translator`
9791
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for [#41](https://github.com/DeepLcom/deepl-php/pull/41)
9892

99-
10093
## [1.6.0] - 2023-11-03
10194
### Added
102-
* Add optional `context` parameter for text translation, that specifies
95+
- Add optional `context` parameter for text translation, that specifies
10396
additional context to influence translations, that is not translated itself.
104-
### Changed
105-
* Added notice in Readme that starting in 2024 the library will drop support for PHP versions that are officially end-of-life.
10697

98+
### Changed
99+
- Added notice in Readme that starting in 2024 the library will drop support for PHP versions that are officially end-of-life.
107100

108101
## [1.5.1] - 2023-09-11
109102
### Fixed
110-
* Add `.gitattributes` file to exclude irrelevant files from package download.
103+
- Add `.gitattributes` file to exclude irrelevant files from package download.
111104
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for [#30](https://github.com/DeepLcom/deepl-php/pull/30)
112-
* Internal CI improvements.
113-
105+
- Internal CI improvements.
114106

115107
## [1.5.0] - 2023-06-26
116108
### Added
117-
* Allow users to supply their own custom HTTP client to the `Translator` object, in order to configure timeouts, security features etc more granularly.
109+
- Allow users to supply their own custom HTTP client to the `Translator` object, in order to configure timeouts, security features etc more granularly.
118110
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for the good input and work in [#22](https://github.com/DeepLcom/deepl-php/pull/22)
119-
* Add curl version to the platform info in the user-agent header (will not be added if the user opts out).
111+
- Add curl version to the platform info in the user-agent header (will not be added if the user opts out).
112+
120113
### Fixed
121-
* Allow users to translate empty strings without throwing an error.
114+
- Allow users to translate empty strings without throwing an error.
122115
* Thanks to [VincentLanglet](https://github.com/VincentLanglet) for the work in [#24](https://github.com/DeepLcom/deepl-php/pull/24)
123-
* Catch any exception thrown when computing the user-agent header and continue without failing the request.
124-
116+
- Catch any exception thrown when computing the user-agent header and continue without failing the request.
125117

126118
## [1.4.0] - 2023-05-24
127119
### Added
128-
* Script to check our source code for license headers and a step for them in the CI.
129-
* Added platform and node version information to the user-agent string that is sent with API calls, along with an opt-out.
130-
* Add method for applications that use this library to identify themselves in API requests they make.
131-
### Fixed
132-
* Fix getUsage request to be a HTTP GET request, not POST.
133-
* Changed document translation to poll the server every 5 seconds. This should greatly reduce observed document translation processing time.
120+
- Script to check our source code for license headers and a step for them in the CI.
121+
- Added platform and node version information to the user-agent string that is sent with API calls, along with an opt-out.
122+
- Add method for applications that use this library to identify themselves in API requests they make.
134123

124+
### Fixed
125+
- Fix getUsage request to be a HTTP GET request, not POST.
126+
- Changed document translation to poll the server every 5 seconds. This should greatly reduce observed document translation processing time.
135127

136128
## [1.3.0] - 2023-01-26
137129
### Added
138-
* New languages available: Korean (`'ko'`) and Norwegian (bokmål) (`'nb'`). Add language code constants and tests.
130+
- New languages available: Korean (`'ko'`) and Norwegian (bokmål) (`'nb'`). Add language code constants and tests.
139131

140132
Note: older library versions also support the new languages, this update only adds new code constants.
141133

142-
143134
## [1.2.1] - 2023-01-25
144135
### Fixed
145-
* Also send options in API requests even if they are default values.
146-
136+
- Also send options in API requests even if they are default values.
147137

148138
## [1.2.0] - 2022-11-11
149139
### Changed
150-
* Added dependency on `psr/log`. As this package forms a PHP Standard
140+
- Added dependency on `psr/log`. As this package forms a PHP Standard
151141
Recommendation, we don't consider it to break backward-compatibility.
142+
152143
### Fixed
153-
* Change the type of the `TranslatorOptions::LOGGER` option to
144+
- Change the type of the `TranslatorOptions::LOGGER` option to
154145
`Psr\Log\LoggerInterface`, to correctly support PSR-3 loggers.
155146
* Pull request [#12](https://github.com/DeepLcom/deepl-php/pull/12)
156147
thanks to [Schleuse](https://github.com/Schleuse).
157148

158-
159149
## [1.1.0] - 2022-09-28
160150
### Added
161-
* Add new formality options: `'prefer_less'` and `'prefer_more'`.
151+
- Add new formality options: `'prefer_less'` and `'prefer_more'`.
152+
162153
### Changed
163-
* Requests resulting in `503 Service Unavailable` errors are now retried.
154+
- Requests resulting in `503 Service Unavailable` errors are now retried.
164155
Attempting to download a document before translation is completed will now
165156
wait and retry (up to 5 times by default), rather than throwing an exception.
166157

167-
168158
## [1.0.0] - 2022-09-08
169159
Stable release.
160+
170161
### Added
171-
* Add glossary management support.
172-
* New language available: Ukrainian (`'uk'`). Add language code constant and tests.
162+
- Add glossary management support.
163+
- New language available: Ukrainian (`'uk'`). Add language code constant and tests.
173164

174165
Note: older library versions also support new languages, this update only adds new code constant.
175-
* Add proxy support.
176-
166+
- Add proxy support.
177167

178168
## [0.4.1] - 2022-08-12
179169
### Changed
180-
* Update contributing guidelines, we can now accept Pull Requests.
170+
- Update contributing guidelines, we can now accept Pull Requests.
171+
181172
### Fixed
182-
* Fix GitLab CI config.
183-
* Fix a typo in the readme.
173+
- Fix GitLab CI config.
174+
- Fix a typo in the readme.
184175
* Pull request [#5](https://github.com/DeepLcom/deepl-php/pull/5)
185176
thanks to [MartkCz](https://github.com/MartkCz).
186177

187-
188178
## [0.4.0] - 2022-05-24
189179
### Added
190-
* Add support for document translation.
191-
180+
- Add support for document translation.
192181

193182
## [0.3.0] - 2022-05-18
194183
### Added
195-
* New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add language code constants and tests.
184+
- New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add language code constants and tests.
196185

197186
Note: older library versions also support the new languages, this update only adds new code constants.
198187

199-
200188
## [0.2.0] - 2022-05-02
201189
### Changed
202-
* Remove `final` keyword from class declarations to facilitate testing.
203-
190+
- Remove `final` keyword from class declarations to facilitate testing.
204191

205192
## [0.1.1] - 2022-04-28
206193
### Fixed
207-
* Added minimum supported PHP version to composer.json.
208-
* Fix cURL client issue: do not round timeouts to whole seconds.
209-
* Fix cURL client issue: consider empty response a retryable-error.
210-
* Check for and reject invalid `server_url` option.
211-
194+
- Added minimum supported PHP version to composer.json.
195+
- Fix cURL client issue: do not round timeouts to whole seconds.
196+
- Fix cURL client issue: consider empty response a retryable-error.
197+
- Check for and reject invalid `server_url` option.
212198

213199
## [0.1.0] - 2022-04-22
214200
Initial version.
215201

216-
202+
[Unreleased]: https://github.com/DeepLcom/deepl-php/compare/v1.12.0...HEAD
217203
[1.12.0]: https://github.com/DeepLcom/deepl-php/compare/v1.11.1...v1.12.0
218204
[1.11.1]: https://github.com/DeepLcom/deepl-php/compare/v1.11.0...v1.11.1
219205
[1.11.0]: https://github.com/DeepLcom/deepl-php/compare/v1.10.1...v1.11.0
@@ -239,5 +225,3 @@ Initial version.
239225
[0.2.0]: https://github.com/DeepLcom/deepl-php/compare/v0.1.1...v0.2.0
240226
[0.1.1]: https://github.com/DeepLcom/deepl-php/compare/v0.1.0...v0.1.1
241227
[0.1.0]: https://github.com/DeepLcom/deepl-php/releases/tag/v0.1.0
242-
243-
[replacement-char]: https://en.wikipedia.org/wiki/Replacement_character

0 commit comments

Comments
 (0)