Improve the explanation about backtick templates #5819
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
heshanpadmasiri
requested review from
MaryamZi,
NipunaRanasinghe and
gimantha
as code owners
|
MaryamZi
reviewed
Nov 8, 2024
There was a problem hiding this comment.
Do we really need a separate BBE? Can't we just add https://ballerina.io/learn/by-example/regexp-type/ as a related link?
| import ballerina/io; | ||
|
|
||
| public function main() { | ||
| // Note first \n is treated as is. |
There was a problem hiding this comment.
Suggested change
| // Note first \n is treated as is. | |
| // Note how the first `\n` is treated as is. |
| string s1 = string `line one \n rest of line 1 ${"\n"} second line`; | ||
| io:println(s1); | ||
|
|
||
| // You can use interpolations to add ` and $ characters. |
There was a problem hiding this comment.
Need to emphasize the characters using backticks. Need to check if/how this can be done.
| string s1 = string `line one \n rest of line 1 ${"\n"} second line`; | ||
| io:println(s1); | ||
|
|
||
| // You can use interpolations to add ` and $ characters. |
There was a problem hiding this comment.
The form needs to be changed IMO.
Suggested change
| // You can use interpolations to add ` and $ characters. | |
| // Use interpolations to add ` and $ characters. |
| string s2 = string `Backtick: ${"`"} Dollar: ${"$"}`; | ||
| io:println(s2); | ||
|
|
||
| // You can nest template expressions. |
There was a problem hiding this comment.
Suggested change
| // You can nest template expressions. | |
| // Template expressions can be nested. |
| io:println(s3); | ||
|
|
||
| // You can use an empty string interpolation to break a template expression | ||
| // across multiple lines |
There was a problem hiding this comment.
or break at interpolations.
Let's add examples with both.
Also need a fullstop at the end.
| @@ -0,0 +1,3 @@ | |||
| # String templates | |||
|
|
|||
| A string template is a template expression that can be used to create a string literal. It consists of a `string` tag and a sequence of characters interleaved with interpolations (in the form `${expression}`). Each interpolation must be a subtype of `boolean|int|float|decimal|string`. Every character not a part of the interpolation is interpreted as is to form a sequence of string literals broken at interpolations. This means if you want to add any escape characters you must add them as interpolations (for example `${"\n"}`). Every interpolation is converted to a string using the `toString` method and concatenated with the other string literals to form a single string literal. | |||
There was a problem hiding this comment.
Suggested change
| A string template is a template expression that can be used to create a string literal. It consists of a `string` tag and a sequence of characters interleaved with interpolations (in the form `${expression}`). Each interpolation must be a subtype of `boolean|int|float|decimal|string`. Every character not a part of the interpolation is interpreted as is to form a sequence of string literals broken at interpolations. This means if you want to add any escape characters you must add them as interpolations (for example `${"\n"}`). Every interpolation is converted to a string using the `toString` method and concatenated with the other string literals to form a single string literal. | |
| A string template is a template expression that can be used to create a string literal. It consists of a `string` tag and a sequence of characters interleaved with interpolations (in the form `${expression}`). Each interpolation must be a subtype of `boolean|int|float|decimal|string`. Every character not a part of the interpolation is interpreted as is to form a sequence of string literals broken at interpolations. This means if you want to add any escape characters you must add them as interpolations (for example `${"\n"}`). Every interpolation is converted to a string using the `toString` lang lib function and concatenated with the other string literals to form a single string literal. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
$subject
Resolves ballerina-platform/ballerina-dev-website#9281
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning