Skip to content

Commit 3b17800

Browse files
CLIENT-SPECIFICATION: 2.3 release (#15866)
Co-authored-by: Sebastiaan Speck <[email protected]>
1 parent e3198a0 commit 3b17800

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

CLIENT-SPECIFICATION.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- markdownlint-disable MD007 MD013 MD024-->
22
# tldr-pages client specification
33

4-
**Current Specification Version:** Unreleased
4+
**Current Specification Version:** 2.3
55

66
This document contains the official specification for tldr-pages clients. It is _not_ a specification of the format of the pages themselves - only a specification of how a user should be able to interface with an official client. For a list of previous versions of the specification, see the [changelog section](#changelog) below.
77

@@ -126,7 +126,7 @@ Although this specification is about the interface that clients must provide, it
126126
Things to take into account:
127127
- Clients MAY highlight the placeholders and MUST remove the surrounding curly braces.
128128
- If option placeholders are set to show only shortform or longform options, they MUST not be highlighted. This is because there is no longer user choice involved.
129-
- Clients MUST remove the angle brackets from option placeholders when only short- or longform is shown.
129+
- Clients MUST remove the square brackets from option placeholders when only short- or longform is shown.
130130
- Clients MUST NOT treat them as the placeholder syntax if they are escaped using `\` (i.e. `\{\{` and `\}\}`) and MUST instead display literal braces, without backslashes. Placeholder escaping applies only when both braces are escaped (e.g. in `\{` or `\{{`, backslashes MUST be displayed).
131131
- In cases when a command uses `{}` in its arguments (e.g. `stash@{0}`) **_the outer braces_** mark the placeholder - the braces inside MUST be displayed.
132132
- Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
@@ -254,8 +254,11 @@ the form `vX.Y`) should be done immediately AFTER merging the version bump, as
254254
the commit hash changes when merging with squash or rebase.
255255
-->
256256

257-
- Unreleased
257+
- [v2.3, March 7th 2025](https://github.com/tldr-pages/tldr/blob/v2.3/CLIENT-SPECIFICATION.md) ([#15866](https://github.com/tldr-pages/tldr/pull/15866))
258258
- Added longform/shortform specifications ([#15253](https://github.com/tldr-pages/tldr/pull/15253))
259+
- Specify `common` as a supported platform option ([#15855](https://github.com/tldr-pages/tldr/pull/15855))
260+
- Add the date of removal of the old asset website ([#15862](https://github.com/tldr-pages/tldr/pull/15862))
261+
- Various grammar fixes
259262

260263
- [v2.2, March 20th 2024](https://github.com/tldr-pages/tldr/blob/v2.2/CLIENT-SPECIFICATION.md) ([#12452](https://github.com/tldr-pages/tldr/pull/12452))
261264
- Removed redirect text from the [caching section](#caching) ([#12133](https://github.com/tldr-pages/tldr/pull/12133))

0 commit comments

Comments
 (0)