Skip to content

CLIENT-SPECIFICATION: require support for common as an arg in platform flag #15855

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

Merged
merged 2 commits into from
Mar 4, 2025

Conversation

kbdharun
Copy link
Member

@kbdharun kbdharun commented Mar 4, 2025

  • The PR title conforms to the recommended templates.

image

As discussed in #15253 (comment) and in the chatroom this PR updates the client spec to require clients to support passing common as a platform to the platform flag i.e. tldr -p common some-command when a page exists in the native platform too but is a bit different (i.e. non POSIX, etc).

We currently document a lot of POSIX variant pages in common and use the above format to reference pages but it was brought to my notice by a user that some clients (both official and community ones) don't support this behavior yet, this addition ensures that this works the same regardless of the client.

@kbdharun kbdharun requested a review from Managor March 4, 2025 17:17
@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Mar 4, 2025
Copy link
Collaborator

@Managor Managor left a comment

Choose a reason for hiding this comment

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

Looks good to go after this

@Managor Managor merged commit bab3a27 into main Mar 4, 2025
8 checks passed
@Managor Managor deleted the client-spec/common-arg-platform branch March 4, 2025 23:43
sebastiaanspeck pushed a commit to sebastiaanspeck/tldr that referenced this pull request Mar 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues/PRs modifying the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants