Skip to content

Preset documentation is confusing / contradictory #108

Description

@lurch

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." ?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions