Skip to content
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.

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

pages/common: fix typos in placeholders #11949

Merged
merged 1 commit into from
Dec 31, 2023
Merged

Conversation

kbdharun
Copy link
Member

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

Ref. #11850

Although this still will have a non-placeholder bracket it is much better than not being shown itself.

image

@kbdharun kbdharun added the minor change Change(s) to an existing page(s) which is minor. label Dec 30, 2023
@github-actions github-actions bot added the page edit Changes to an existing page(s). label Dec 30, 2023
@vitorhcl vitorhcl self-requested a review December 30, 2023 16:39
Copy link
Member

@vitorhcl vitorhcl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for that, didn't pay enough attention when doing those changes

@acuteenvy
Copy link
Member

Although this still will have a non-placeholder bracket

I've already mentioned this here - {{{something}}} is undefined by our client specification.

https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#page-structure

the non-standard {{ and }} placeholder syntax surrounds values in an example that users may edit.

This is ambiguous. The "value" in this case can be:

  • {something} (outer braces mark the placeholder)
  • something (inner braces mark the placeholder)
  • {something (outer at the beginning, inner at the end)
  • something} (inner at the beginning, outer at the end)

This is possible to fix, but we have to clearly define that the outer braces mark the placeholder.

@kbdharun
Copy link
Member Author

This is possible to fix, but we have to clearly define that the outer braces mark the placeholder.

Yeah, we can add something like this to the client specification in future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor change Change(s) to an existing page(s) which is minor. page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants