Skip to content

Output stream reference standardization #9596

@EmilyGraceSeville7cf

Description

@EmilyGraceSeville7cf

Description

Example usage is here. General syntax is suggested to be as the following one: (output stream: stdout), (output stream: stderr), (output stream: stdout when {{condition}}), (output stream: stderr when {{condition}}), or (output stream: {{stream_name1}} when {{condition1}}, and output stream: {{stream_name2}} when {{condition2}}).

Questions

  • When to use output stream reference syntax? Answer: always at the end of the code example descriptions.
  • Why to always mention output streams explicitly? Answer: as shells heavily rely on i/o streams, to be able correctly discard normal or error output without digging in manual or manually checking it's better to know exactly where output goes to.
  • Why to create special syntax instead of letting users to decide how to mention output streams and? Answer: lack of standardization don't allow us filter pages by output stream criteria, user may wanna find command that writes errors to stderr and normal output to stdout, instead of everything to stdout.

Changes target

Official TlDr client specification and our official clients. Third party clients should be responsible for such changes themselves: they are not mandated to follow the latest specification version. There are too many clients uncontrolled by us to make it a strong argument against some new features.

Responsible for changes in our clients

Me.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions