Skip to content

Commit d82df1d

Browse files
daniel-jones-devdaniel-jones-dev
committed
docs: changelog formatting
1 parent 4e639a6 commit d82df1d

File tree

1 file changed

+56
-65
lines changed

1 file changed

+56
-65
lines changed

‎CHANGELOG.md‎

Lines changed: 56 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -5,194 +5,186 @@ 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 `ExtraBodyParameters` 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 `ExtraBodyParameters` 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.15.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.14.0] - 2025-02-25
2120
### Added
22-
* Added support for the `output_format` parameter when translating documents.
21+
- Added support for the `output_format` parameter when translating documents.
2322
* [#50](https://github.com/DeepLcom/deepl-dotnet/pull/50) thanks for [JuergenRB](https://github.com/JuergenRB)
2423

2524
## [1.13.0] - 2025-01-28
2625
### Added
27-
* Added support for the Write API in the client library, the implementation
26+
- Added support for the Write API in the client library, the implementation
2827
can be found in the `DeepLClient` class. Please refer to the README for usage
2928
instructions.
30-
### Fixed
31-
* Fixed code example for getting glossary entries in the README
32-
* [#58](https://github.com/DeepLcom/deepl-dotnet/issues/58) thanks to [KurtBildeSDU](https://github.com/KurtBildeSDU)
29+
3330
### Changed
34-
* The main functionality of the library is now also exposed via the `DeepLClient`
31+
- The main functionality of the library is now also exposed via the `DeepLClient`
3532
class. Please change your code to use this over the `Translator` class whenever
3633
convenient.
3734

35+
### Fixed
36+
- Fixed code example for getting glossary entries in the README
37+
* [#58](https://github.com/DeepLcom/deepl-dotnet/issues/58) thanks to [KurtBildeSDU](https://github.com/KurtBildeSDU)
38+
3839
## [1.12.0] - 2025-01-09
3940
### Added
40-
* Added document minification as a feature before document translation, to
41+
- Added document minification as a feature before document translation, to
4142
allow translation of large docx or pptx files. For more info check the README.
4243

43-
4444
## [1.11.0] - 2024-11-15
4545
### Added
46-
* Added `ModelType` option for text translation to use models with higher
46+
- Added `ModelType` option for text translation to use models with higher
4747
translation quality (available for some language pairs), or better latency.
4848
Options are:
4949
- `ModelType.QualityOptimized ('quality_optimized')`,
5050
- `ModelType.QualityOptimized ('latency_optimized')`, and
5151
- `ModelType.QualityOptimized ('prefer_quality_optimized')`
52-
* Added the `ModelTypeUsed` field to text translation response, that
52+
- Added the `ModelTypeUsed` field to text translation response, that
5353
indicates the translation model used when the `ModelType` option is
5454
specified.
5555

56-
5756
## [1.10.0] - 2024-09-17
5857
### Added
59-
* Added `BilledCharacters` to the translate text response.
60-
58+
- Added `BilledCharacters` to the translate text response.
6159

6260
## [1.9.0] - 2024-03-15
6361
### Added
64-
* New language available: Arabic (MSA) (`'ar'`). Add language code constants and tests.
62+
- New language available: Arabic (MSA) (`'ar'`). Add language code constants and tests.
6563

6664
Note: older library versions also support the new language, this update only
6765
adds new code constants.
6866
* [#44](https://github.com/DeepLcom/deepl-dotnet/pull/44) thanks to [Ilmalte](https://github.com/ilmalte)
67+
6968
### Fixed
70-
* Change document upload to use the path `/v2/document` instead of `/v2/document/` (no trailing `/`).
69+
- Change document upload to use the path `/v2/document` instead of `/v2/document/` (no trailing `/`).
7170
Both paths will continue to work in the v2 version of the API, but `/v2/document` is the intended one.
72-
* Made `DeepLException` and subclasses, `Usage` and `JsonFieldsStruct` constructors public, to allow for easier mocking of the `ITranslator` interface.
71+
- Made `DeepLException` and subclasses, `Usage` and `JsonFieldsStruct` constructors public, to allow for easier mocking of the `ITranslator` interface.
7372
* [#40](https://github.com/DeepLcom/deepl-dotnet/issues/40) thanks to [PascalVorwerkSaixon](https://github.com/PascalVorwerkSaxion)
7473

75-
7674
## [1.8.0] - 2023-11-03
7775
### Added
78-
* Add optional `Context` parameter for text translation, that specifies
76+
- Add optional `Context` parameter for text translation, that specifies
7977
additional context to influence translations, that is not translated itself.
80-
### Changed
81-
* Improvements to readme examples.
8278

79+
### Changed
80+
- Improvements to readme examples.
8381

8482
## [1.7.1] - 2023-04-17
8583
### Fixed
86-
* Changed document translation to poll the server every 5 seconds. This should greatly reduce observed document translation processing time.
84+
- Changed document translation to poll the server every 5 seconds. This should greatly reduce observed document translation processing time.
8785

8886
## [1.7.0] - 2023-03-22
8987
### Added
90-
* Script to check our source code for license headers and a step for them in the CI.
91-
* Added platform and node version information to the user-agent string that is sent with API calls, along with an opt-out.
92-
* Added method for applications that use this library to identify themselves in API requests they make.
88+
- Script to check our source code for license headers and a step for them in the CI.
89+
- Added platform and node version information to the user-agent string that is sent with API calls, along with an opt-out.
90+
- Added method for applications that use this library to identify themselves in API requests they make.
9391

9492
## [1.6.0] - 2023-01-26
9593
### Added
96-
* New languages available: Korean (`'ko'`) and Norwegian (bokmål) (`'nb'`). Add
94+
- New languages available: Korean (`'ko'`) and Norwegian (bokmål) (`'nb'`). Add
9795
language code constants and tests.
9896

9997
Note: older library versions also support the new languages, this update only
10098
adds new code constants.
10199

102-
103100
## [1.5.1] - 2023-01-25
104101
### Fixed
105-
* Fix CI build for netcoreapp3.1.
106-
* Fix `Formality` options `PreferLess` and `PreferMore` for document
102+
- Fix CI build for netcoreapp3.1.
103+
- Fix `Formality` options `PreferLess` and `PreferMore` for document
107104
translation.
108105

109-
110106
## [1.5.0] - 2022-09-30
111107
### Added
112-
* Add new `Formality` options: `PreferLess` and `PreferMore`.
108+
- Add new `Formality` options: `PreferLess` and `PreferMore`.
109+
113110
### Changed
114-
* Requests resulting in `503 Service Unavailable` errors are now retried.
111+
- Requests resulting in `503 Service Unavailable` errors are now retried.
115112
Attempting to download a document before translation is completed will now
116113
wait and retry (up to 5 times by default), rather than throwing an exception.
117114

118-
119115
## [1.4.0] - 2022-09-09
120116
### Added
121-
* New language available: Ukrainian (`'uk'`). Add language code constant and
117+
- New language available: Ukrainian (`'uk'`). Add language code constant and
122118
tests.
123119

124120
Note: older library versions also support new languages, this update only
125121
adds new code constant.
126122

127-
128123
## [1.3.0] - 2022-08-02
129124
### Added
130-
* Add `Translator.createGlossaryFromCsvAsync()` allowing glossaries downloaded
125+
- Add `Translator.createGlossaryFromCsvAsync()` allowing glossaries downloaded
131126
from website to be easily uploaded to API.
132-
### Changed
133-
* Strong name DeepL.net assembly.
134127

128+
### Changed
129+
- Strong name DeepL.net assembly.
135130

136131
## [1.2.1] - 2022-06-29
137132
### Changed
138-
* Update contributing guidelines, we can now accept Pull Requests.
139-
### Fixed
140-
* Fix bug in OutlineDetection option for text translation.
133+
- Update contributing guidelines, we can now accept Pull Requests.
141134

135+
### Fixed
136+
- Fix bug in OutlineDetection option for text translation.
142137

143138
## [1.2.0] - 2022-05-18
144139
### Added
145-
* New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add
140+
- New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add
146141
language code constants and tests.
147142

148143
Note: older library versions also support the new languages, this update only
149144
adds new code constants.
150-
* Added `ITranslator` interface implemented by `Translator` class, to achieve a
145+
- Added `ITranslator` interface implemented by `Translator` class, to achieve a
151146
better mock-ability in conjunction with common mocking frameworks.
147+
152148
### Changed
153-
* Improve package icon, tags and project URLs.
154-
### Fixed
155-
* Test fix: tests should still succeed after new languages are added.
149+
- Improve package icon, tags and project URLs.
156150

151+
### Fixed
152+
- Test fix: tests should still succeed after new languages are added.
157153

158154
## [1.1.0] - 2022-04-13
159155
### Added
160-
* Add `ErrorMessage` property to `DocumentStatus` that contains a short
156+
- Add `ErrorMessage` property to `DocumentStatus` that contains a short
161157
description of document translation error, if available.
162158

163-
164159
## [1.0.5] - 2022-04-12
165160
### Added
166-
* Add support for `TextTranslateOptions.TagHandling = "html"`. No code changes
161+
- Add support for `TextTranslateOptions.TagHandling = "html"`. No code changes
167162
were needed, only comments and tests were changed.
168-
* Add test for proxy support.
169-
### Fixed
170-
* Fix some tests that intermittently failed.
163+
- Add test for proxy support.
171164

165+
### Fixed
166+
- Fix some tests that intermittently failed.
172167

173168
## [1.0.4] - 2022-01-27
174169
### Fixed
175-
* Fix issue in .NET versions earlier than 5.0, when creating large glossaries or
176-
translating texts larger than 64 KiB.
177-
170+
- Fix issue in .NET versions earlier than 5.0, when creating large glossaries or
171+
translating texts larger than 64 KiB.
178172

179173
## [1.0.3] - 2022-01-19
180174
### Added
181-
* Add contribution guidelines -- currently we are unable to accept Pull Requests.
182-
### Changed
183-
* Improve README tests section.
175+
- Add contribution guidelines -- currently we are unable to accept Pull Requests.
184176

177+
### Changed
178+
- Improve README tests section.
185179

186180
## [1.0.2] - 2022-01-03
187181
### Changed
188182
- Include additional information with error status codes.
189183

190-
191184
## [1.0.1] - 2021-12-07
192185
### Fixed
193186
- Use default HTTP version in requests rather than always using HTTP/2.
194187

195-
196188
## [1.0.0] - 2021-11-18
197189
### Changed
198190
- Add missing properties in package, e.g. icon.
@@ -201,7 +193,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
201193
- Exceptions thrown by some functions were changed to use standard exceptions.
202194
- Improvements to tests, README and documentation.
203195

204-
205196
## [0.1.0] - 2021-11-05
206197
Initial release.
207198

0 commit comments

Comments
 (0)