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

Specify build target arguments (or not) consistently in docs #384

Open
cfr42 opened this issue Sep 25, 2024 · 2 comments
Open

Specify build target arguments (or not) consistently in docs #384

cfr42 opened this issue Sep 25, 2024 · 2 comments

Comments

@cfr42
Copy link

cfr42 commented Sep 25, 2024

For check we have

$ l3build check ⟨name(s) ⟩

Similar syntax is used for save, tag and upload.

For doc we have

$ l3build doc

The explanation does imply <name(s)> can be given, since it says what happens if none are specified. But this is not great for quickly checking whether arguments are allowed here, so I'd personally prefer the first syntax to the second, but consistent use of either would be less confusing since it would be obvious you had to scan through the text in that case.

@josephwright
Copy link
Member

Where are you looking? In the docs, we have l3build check then l3build check <names>, and l3build doc followed by l3build doc <names>, etc.

@cfr42
Copy link
Author

cfr42 commented Sep 26, 2024

Where are you looking?

I'm really, really sorry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants