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.

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

Jump to bottom

style-guide.md: write quoting rule in descriptions #9528

Closed
wants to merge 9 commits into from
Closed

style-guide.md: write quoting rule in descriptions #9528

wants to merge 9 commits into from

Conversation

EmilyGraceSeville7cf
Copy link
Contributor

  • 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): unavailable

@EmilyGraceSeville7cf EmilyGraceSeville7cf self-assigned this Nov 19, 2022
@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Nov 19, 2022
@EmilyGraceSeville7cf EmilyGraceSeville7cf mentioned this pull request Nov 19, 2022
Closed
5 tasks
@kbdharun kbdharun added the review needed Prioritized PRs marked for reviews from maintainers. label Nov 26, 2022
@github-actions
Copy link

Hi all! This thread has not had any recent activity.
Are there any updates? Thanks!

@github-actions github-actions bot added the waiting Issues/PRs with Pending response by the author. label Dec 12, 2022
@EmilyGraceSeville7cf EmilyGraceSeville7cf requested review from pixelcmtd and removed request for navarroaxel December 13, 2022 03:37
@github-actions github-actions bot removed the waiting Issues/PRs with Pending response by the author. label Dec 14, 2022
Emily Grace Seville and others added 2 commits December 15, 2022 22:29
@CLAassistant
Copy link

CLAassistant commented Dec 28, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

sbrl
sbrl requested changes Jan 10, 2023
View reviewed changes
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Requesting changes to block merging given my objections detailed above.

SethFalco
SethFalco reviewed Jan 11, 2023
View reviewed changes
contributing-guides/style-guide.md Outdated
## Description syntax

- Use double quotes for quoting.
- Quote just strings.
Copy link
Member

Choose a reason for hiding this comment

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

Sorry, I can't say I understand what this means. 🤔
Could you elaborate in the comments?

Copy link
Contributor Author

@EmilyGraceSeville7cf EmilyGraceSeville7cf Jan 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

It means that when you wanna quote smth in description always use double quotes. For instance what if I wanna mention some string literal used in code example? I should write "some literal text here" and not with single quotes. Maybe I have to reword it.

Copy link
Member

Choose a reason for hiding this comment

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

Ahh, sorry! I meant more specifically: "Quote just strings."
I understood the goal of this was to specify the use of double-quotes, but don't understand what is meant by "Quote just strings."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is wording better now?

SethFalco
SethFalco reviewed Jan 12, 2023
View reviewed changes
contributing-guides/style-guide.md
@@ -104,6 +104,11 @@ Example:
```
- Pre-translated alias page templates can be found [here](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md).

## Description syntax

- Use double quotes for quoting strings in descriptions.
Copy link
Member

Choose a reason for hiding this comment

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

I think I understand what you mean now. So like quoting an excerpt from documentation?

If that's not what you mean, could you share an example, sorry. ^-^'

Then I can respond to this properly.

@sebastiaanspeck sebastiaanspeck deleted the feature/refresh-style-guide-quoting-descriptions branch November 19, 2023 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SethFalco SethFalco SethFalco left review comments

@kbdharun kbdharun kbdharun approved these changes

@pixelcmtd pixelcmtd Awaiting requested review from pixelcmtd

@navarroaxel navarroaxel Awaiting requested review from navarroaxel

@sbrl sbrl Awaiting requested review from sbrl sbrl is a code owner

@blueskyson blueskyson Awaiting requested review from blueskyson

Assignees

@EmilyGraceSeville7cf EmilyGraceSeville7cf

Labels
documentation Issues/PRs modifying the documentation. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@EmilyGraceSeville7cf @CLAassistant @sbrl @SethFalco @kbdharun