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

Preset documentation is confusing / contradictory #108

Open
lurch opened this issue Jan 29, 2018 · 1 comment
Open

Preset documentation is confusing / contradictory #108

lurch opened this issue Jan 29, 2018 · 1 comment
Labels

Comments

@lurch
Copy link
Contributor

lurch commented Jan 29, 2018

Whilst looking at https://github.com/resin-io/versionist/blob/master/README.md I noticed that each of the config parameters that also accepts a preset value (e.g. incrementVersion ) is documented as being of type (Function|String) and says "You can also import a built-in preset by passing its name.".

However when you scroll down the the section about presets it actually says "You can specify a preset for a function hook in the following formats: String value, Object value".

Does this mean that each of the config parameters that accepts a preset should actually be documented as type (Function|String|Object), with the text part then being updated to say something like "You can also import a built-in preset by passing its name or a suitable preset object." ?

@lurch lurch added the question label Jan 29, 2018
@lurch
Copy link
Contributor Author

lurch commented Jan 29, 2018

Haha, connects to #89 which I also authored 😀

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

No branches or pull requests

1 participant