Style question: What about variable number of arguments (varargs)?

[xeruf]

In some cases, one or multiple (or even zero) of an argument can be passed, should we use any specific syntax here? Didn't find anything on https://github.com/tldr-pages/tldr/blob/master/contributing-guides/style-guide.md#token-syntax.

I was thinking of the classical ... which I started using in a PR already: xeruf@ab75453
The question then is whether to use singular or plural, i.e. files... or file....

[bl-ue]

I made a suggestion here: #5787 (comment)

As a matter of fact, I very recently brought this question up: #5768 (comment). My preferred style would be like this:

command {{path/to/file1 path/to/file2 ...}}

Multiple items being inside one token syntax section like that indicates that the position and count of the arguments is variable.

Another nice about that style is that it's relatively compact, as opposed to methods such as

command {{path/to/file_A path/to/file_B ... path/to/file_N}}

Which is longer and less common in our current pages.

[Waples]

I'm siding beside @bl-ue.
just stuff them in there.

[sbrl]

Personally I've used {{thing1}} {{thing2}} {{thingN}} myself, but I don't think we need a hard and fast rule here as it's dependent on context. {{thing1 thing2 ...}} would also be acceptable, as would {{thing1|thing2|...}} for a choice of only 1 option.

[bl-ue]

I prefer my suggestion because it looks shorted to me than the 1, 2, N approach.

[xeruf]

I prefer my suggestion because it looks shorted to me than the 1, 2, N approach.

I agree - using N might incline some users to ask what the N stands for

[marchersimon]

What do yout think about making an issue or a file, where we collect all conventions we decided upon?

[sbrl]

@marchersimon Maybe, but I think it's a bit too dependent on context to make a hard and fast rule about it.

[marchersimon]

Seems fair. After all it isn't bad to re-discuss some topics from time to time.

[xeruf]

y'all know that there already is a file for conventions? ;) https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#token-syntax

[sbrl]

Yeah, but we generally speaking try to keep that guide relatively short @xeruf to avoid exhausting new contributors :P

[xeruf]

Well, there should be a single point of truth, and I think this file is appropriate for that.
As a new contributor I didn't look at that file right away anyways.