Skip to content

Fix @format decorator doc not escaping correctly #1851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timotheeguerin merged 6 commits into from
Apr 27, 2023
Merged

Fix @format decorator doc not escaping correctly #1851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2159d6
Fix `@format` decorator doc not escaping correctly
timotheeguerin Apr 24, 2023
d997997
.
timotheeguerin Apr 24, 2023
31cc85e
Changelog
timotheeguerin Apr 24, 2023
8c83c04
Update docs/standard-library/built-in-decorators.md
timotheeguerin Apr 25, 2023
8da1a25
Update packages/compiler/lib/decorators.tsp
timotheeguerin Apr 25, 2023
6dbc0f8
Merge branch 'main' into timotheeguerin-patch-1
timotheeguerin Apr 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions common/changes/@typespec/compiler/timotheeguerin-patch-1_2023-04-24-16-51.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@typespec/compiler",
"comment": "Fix `@format` decorator doc.",
"type": "none"
}
],
"packageName": "@typespec/compiler"
}
3 changes: 2 additions & 1 deletion docs/standard-library/built-in-decorators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ message: string;
### `@format` {#@format}

Specify a known data format hint for this string type. For example `uuid`, `uri`, etc.
This differ from the
This differs from the `@pattern` decorator which is meant to specify a regular expression while `@format` accepts a known format name.
The format names are open ended and are left to emitter to interpret.

```typespec
dec format(target: string | bytes | ModelProperty, format: string)
Expand Down
2 changes: 1 addition & 1 deletion packages/compiler/lib/decorators.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ extern dec error(target: Model);

/**
* Specify a known data format hint for this string type. For example `uuid`, `uri`, etc.
* This differ from the @pattern decorator that is meant to specify a regular expression while @format takes in a known format name.
* This differs from the `@pattern` decorator which is meant to specify a regular expression while `@format` accepts a known format name.
* The format names are open ended and are left to emitter to interpret.
*
* @param format format name.
Expand Down