Skip to content
This repository has been archived by the owner on Oct 24, 2024. It is now read-only.

Optional parameter and option definitions are inconsistent #4

Open
sylv opened this issue Apr 14, 2022 · 0 comments
Open

Optional parameter and option definitions are inconsistent #4

sylv opened this issue Apr 14, 2022 · 0 comments

Comments

@sylv
Copy link
Member

sylv commented Apr 14, 2022

In a lot of cases, optional parameters aren't shown as optional at all or are mixed and matched between sections. We should update the docs to use a standard format for optional parameters. I'd say something like {tag required optional? default=value} with the same for parameters, {tag;required;optional?;default=false}.

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

No branches or pull requests

1 participant