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

<, >, |, $: add page #13846

Merged
merged 29 commits into from
Oct 1, 2024
Merged

<, >, |, $: add page #13846

merged 29 commits into from
Oct 1, 2024

Conversation

Managor
Copy link
Collaborator

@Managor Managor commented Sep 26, 2024

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

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Sep 26, 2024
@Managor
Copy link
Collaborator Author

Managor commented Sep 26, 2024

I also wanted to make pages for &, { and ( but those symbols were so multipurpose that I couldn't come up with a concise way to describe them.

@Managor
Copy link
Collaborator Author

Managor commented Sep 26, 2024

Do note that some of these are only reachable by enclosing the symbol in quotes like tldr "<"

pages/common/&gt;.md Outdated Show resolved Hide resolved
Copy link
Member

@acuteenvy acuteenvy left a comment

Choose a reason for hiding this comment

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

On Windows, clients won't be able to extract the pages archive if we merge this, because Windows filenames cannot contain >, < and |.

@Managor
Copy link
Collaborator Author

Managor commented Sep 28, 2024

Not sure how I'd fix that

@acuteenvy
Copy link
Member

In #12091, :.md was renamed to colon.md. Renaming the files is the only possible solution, as there is no way to force Windows to allow these characters in filenames.

@Managor
Copy link
Collaborator Author

Managor commented Sep 29, 2024

tldr-pages/tldr-lint#352
As a reminder for the future.

@Managor
Copy link
Collaborator Author

Managor commented Sep 29, 2024

Would it be reasonable to have hardcoded exceptions in tldr, to redirect requests with forbidden windows filesystem characters to their complementing characters.
As in if I type tldr :, the program searches for tldr colon or tldr ">" gets converted to tldr greater-than
I ask this because I like consistency and being consistent with other symbol based queries like tldr ! would be nice.

pages/common/$.md Show resolved Hide resolved
pages/common/greater-than.md Show resolved Hide resolved
pages/common/less-than.md Show resolved Hide resolved
pages/common/vertical-line.md Outdated Show resolved Hide resolved
@sebastiaanspeck
Copy link
Member

Would it be reasonable to have hardcoded exceptions in tldr, to redirect requests with forbidden windows filesystem characters to their complementing characters.

As in if I type tldr :, the program searches for tldr colon or tldr ">" gets converted to tldr greater-than

I ask this because I like consistency and being consistent with other symbol based queries like tldr ! would be nice.

This is something that our clients should implement, which we need to write in the client-specification. Maybe open a separate discussion for this?

@tldr-bot

This comment was marked as resolved.

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

To prepare for an upcoming change in which we would like to remove www. as much as possible.

pages/common/$.md Outdated Show resolved Hide resolved
pages/common/greater-than.md Outdated Show resolved Hide resolved
pages/common/less-than.md Outdated Show resolved Hide resolved
pages/common/vertical-bar.md Outdated Show resolved Hide resolved
Co-authored-by: Sebastiaan Speck <[email protected]>
@Managor
Copy link
Collaborator Author

Managor commented Sep 30, 2024

After you've removed those unnecessary parts of the urls, add something to tldr bot that automatically detects when specific URLs contains something extra. gnu.org for example always adds www to its urls when you open the link and manned always adds /man/ when navigating there manually.

pages/common/greater-than.md Outdated Show resolved Hide resolved
@spageektti spageektti merged commit ac3c978 into tldr-pages:main Oct 1, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants