String improvements #475

010DevX101 · 2024-03-22T15:13:10Z

Changes

Documented string interpolation in strings.md.
Switched from string concatenation to string interpolation in all scripts when convenient as it is a more modern way of combining strings (introduced in Luau).
Improved script syntax in multiple scripts across the documentation.

Checks

By submitting your pull request for review, you agree to the following:

This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
To the best of my knowledge, all proposed changes are accurate.

…dded backticks concatenation documentation to the Strings documentation.

…to string interpolation when convenient, documented string interpolation.

…rings when suitable

github-actions

Hi @010DevX101, thanks so much for helping improve the Roblox creator documentation! Our technical writing team will review your pull request soon. In the meantime, please ensure you've read through the README.md, contribution guidelines, and style recommendations.

content/en-us/education/build-it-play-it-story-games/finish-and-add.md

content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md

010DevX101 · 2024-03-22T15:39:50Z

Resolved the linting issues.

Nightriff

Great changes for readability. I pointed out the syntax or context issues I found that require further follow up.

content/en-us/education/build-it-play-it-story-games/code-the-story.md

Nightriff · 2024-03-28T22:34:59Z

content/en-us/chat/legacy/admin-commands.md

@@ -197,7 +197,7 @@ function explodeCommand(commandData)
 		local success = makeExplosion(character)

 		if success then
-			Utilities:sendSystemSuccessMessage(commandData, string.format(commandData.Speaker.Name .. " made" .. parameter .. " explode."))
+			Utilities:SendSystemSuccessMessage(commandData, `{commandData.Speaker.Name} made {parameter} explode.`)
 		else
 			Utilities:SendSystemErrorMessage(commandData, string.format("'s' is not a valid player.", parameter))


Converted the above string.format but not this one, we should be consistent. There are other usages that also were missed. Make sure to refine your search query to catch all the applicable cases.

content/en-us/cloud-services/datastores.md

content/en-us/education/build-it-play-it-story-games/code-the-story.md

Nightriff · 2024-03-28T22:42:33Z

content/en-us/education/build-it-play-it-story-games/finish-and-add.md

   ```

-4. In the story variable, concatenate the next story string using `..` Be sure to include a space after the end of the sentence.
+4. In the story variable, define a string using backticks. This allows to concatenate variables using `{}`.


This allows to reads awkwardly

Will be modified.

Nightriff · 2024-03-28T23:00:21Z

content/en-us/studio/texture-generator.md

+
 <TabItem label="Generation Angle">
 The [generation angle](#generation-angle) sets the most important view of your mesh which will be prioritized during generation. Changing this angle can often help eliminate inconsistencies in textures.

 - Setting the generation angle to highlight the meaningful faces of your mesh will result in better generations.
 - For flat objects like plates, swords, and fences, make sure the generation angle displays a view with a high surface area.
 - For humanoid and animal meshes, experiment with different generation angles, such as a head-on view of the face and a side view profile, to find the most consistent and coherent texture.
 </TabItem>
+
 <TabItem label="Iterative Refinement">
 Generating the most suitable textures is an iterative process. It helps to preview often and tweak prompts incrementally to reach your vision.

 - If a texture doesn't meet your expectations, identify what to change instead of starting over. For example, tweak the color or pattern description.
 - Change the prompt word order. Words at the beginning of the prompt can have more weight when generating.
 - Generate several previews to compare different prompts, or try the same prompts with different [seeds](#seed-control) to get a preview that fits your vision.
 </TabItem>
+


Intentional? Does it change anything?

I believe this was a merge of the branch main of this repository and the branch main of my fork.

If this branch is up to date, it shouldn't show any diff to main that you didn't commit

Huh, I don't remember editing that.

Looks like it's from here 034e32d

Possibly an auto-formatter running in your editor; it may or may not be a good change, hard to tell without being able to preview it here

I believe it may have been automatic, when I made the pull request, there were some linting issues and I ran a command in the console which fixed them (can't remember which command right now), I'll take a look though.

Nightriff · 2024-03-28T23:01:02Z

content/en-us/tutorials/fundamentals/coding-1/creating-a-script.md

@@ -159,14 +159,14 @@ Print functions display text on the screen, as you saw earlier. It's one of the

 ### Combining Strings

-You can display any string in the Output using `print()`; you can even print multiple strings stored within variables or typed directly within the function. **Concatenation** is combining strings. To concatenate the string assigned to your variable and a second string, use two dots `..` The following example concatenates two variables and two typed strings.
+You can display any string in the Output using `print()`; you can even print multiple strings stored within variables or typed directly within the function. **Interpolation** is combining strings. To interpolate the string assigned to your variable and a second string, use backticks and brackets (`{}`). The following example interpolates two variables and two typed strings.


Consider removing () so that it doesn't confuse the syntax

Also these backticks will probably be interpreted by the markdown renderer and not show up in the actual syntax example. Probably need to do something like
`` `{}` ``
to get it to show up correctly. Applies elsewhere too, please address this everywhere.

and I had to do backtick inception to get it to show up as desired in this github comment too 😂

I have no idea if it’s even possible for to have backticks as code lol, will try it out though.

https://stackoverflow.com/questions/55586867/how-to-put-in-markdown-an-inline-code-block-that-only-contains-a-backtick-char

https://daringfireball.net/projects/markdown/syntax#code

Consider removing () so that it doesn't confuse the syntax

Where should I remove the parenthesis? In the print() or (`{}`)?
(Also, made the backticks show up together with the brackets)

Was referring to the (`{}`)

Nightriff · 2024-03-28T23:02:09Z

content/en-us/tutorials/fundamentals/coding-1/creating-a-script.md

@@ -175,6 +175,6 @@ Play around with printing different combinations of strings.

 New scripts can be created by clicking the + button next to the name of an object. ServerScriptService is a common place to create new scripts. New scripts include the default code `print("Hello world!")`. This code will display `Hello world!` in the Output window, where you can see the results of your code and if any errors have occurred.

-"Hello world!"' is an example of a string data type. Strings can include any combination of characters that you might type on your keyboard. Concatenation is when multiple strings are combined.
+"Hello world!"' is an example of a string data type. Strings can include any combination of characters that you might type on your keyboard. Interpolation is when multiple strings are combined.


Not an entirely complete definition of interpolation, but may suffice for the purposes of this tutorial. cc @Roblox/documentation for wording review

Should I expand the definition?

I'll let a tech writer comment an opinion on this

Nightriff · 2024-03-28T23:03:51Z

content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md

+   Name = "Bobbie",
+   Type = "Dog",


I think we use tabs (or 4 spaces?), but not 3 spaces, cc @Roblox/documentation for style review

applies here and to below changes in this file

Nightriff · 2024-03-28T23:05:47Z

content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md

-}
+   ```lua
+   local enemy = {
+      Name = "Spike",


Spacing doesn't seem right here, review all these spacing changes on this page please

010DevX101 · 2024-03-29T00:10:57Z

Thanks for the reviews, I’ll make said changes soon.

010DevX101 · 2024-04-03T18:49:31Z

Content check failed when merging from branch main?

010DevX101 · 2024-04-04T12:34:14Z

Error: Process completed with exit code 1. occurs while running quality checks.

github-actions · 2024-04-22T20:03:20Z

This pull request has been inactive for 14 days. If it remains inactive for another 7 days, it will close. Please update or comment on this pull request to keep it open. 🙏

io1ismz · 2024-04-26T14:45:43Z

****

010DevX101 · 2024-04-26T20:02:20Z

I haven’t had time to make said changes. I believe I will either close the pull request until I'm free or make the changes soon.

github-actions · 2024-05-11T08:03:42Z

This pull request has been inactive for 14 days. If it remains inactive for another 7 days, it will close. Please update or comment on this pull request to keep it open. 🙏

github-actions · 2024-05-18T09:03:26Z

This pull request has been inactive for 21 days. It's closing now. Please feel free to reopen it if you still need it. 🙏

010DevX101 added 7 commits March 17, 2024 17:29

Switched concatenation from double dots to backticks when suitable. A…

015b3f3

…dded backticks concatenation documentation to the Strings documentation.

Merge branch 'main' of https://github.com/010DevX101/creator-docs

4beb2dc

Improved string concatenation when convenient

16af491

Documented string concatenation and interpolation

0ae5dfa

Improved syntax for some scripts, switched from string concatenation …

6b9bc0a

…to string interpolation when convenient, documented string interpolation.

Merge branch 'main' of https://github.com/010DevX101/creator-docs

de334ca

Switched from string concatenation to string interpolation for all st…

7e0dfb9

…rings when suitable

010DevX101 requested review from a team as code owners March 22, 2024 15:13

github-actions bot added education Changes the Education content engine guides Changes the Engine guides engine reference Changes the Engine API Reference documentation resources Changes the Resources content tutorials Changes the tutorials labels Mar 22, 2024