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

Page modification request: ! command title #12777

Open
spageektti opened this issue May 11, 2024 · 4 comments
Open

Page modification request: ! command title #12777

spageektti opened this issue May 11, 2024 · 4 comments
Labels
help wanted You can help make tldr-pages better! page edit Changes to an existing page(s).

Comments

@spageektti
Copy link
Collaborator

Command description

We should change the title of the ! (common) command from Exclamation mark to !.
Why?

  • This would be following the Style Guide: The filename and page title must match the command name exactly.
  • This will match the file name: !.md.
  • The name Exclamation mark is understandable for English speakers, but what about translations? In translations, the command name must be the same, so we can't translate them.

I ask for your opinion.

Command details

No response

Documentation

No response

Platform

Common

VCS repository link (e.g. GitHub, GitLab)

No response

Additional information

No response

@spageektti spageektti added help wanted You can help make tldr-pages better! page edit Changes to an existing page(s). labels May 11, 2024
@Managor
Copy link
Collaborator

Managor commented May 13, 2024

That would require modifications to the CI pipeline as it errors out if ! is put as a name

@kbdharun
Copy link
Member

kbdharun commented May 13, 2024

That would require modifications to the CI pipeline as it errors out if ! is put as a name

There are no modifications required to the CI pipeline but rather to tldr-lint.

This page and other pages having symbols as command names can't be set as a title until we update tldr-lint to support it (as I mentioned in the previous discussions regarding the topic). Since there isn't a tracking issue in the tldr-lint repo, I will open one over there for the same.

@Managor
Copy link
Collaborator

Managor commented May 14, 2024

Pardon my lack of knowledge, but isn't tldr-lint part of the pipeline?

@kbdharun
Copy link
Member

Pardon my lack of knowledge, but isn't tldr-lint part of the pipeline?

Technically yes, but it isn't invoked directly in the CI but inside the script also with no modifications required I meant that we don't need to change the ignore rule filters for this addition.

Depedabot will automatically create a PR to bump tldr-lint version on package.json if there is a new release (we could do it too if it's the middle weeks of the month, as dependabot is scheduled to run on 1st).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted You can help make tldr-pages better! page edit Changes to an existing page(s).
Projects
None yet
Development

No branches or pull requests

3 participants