Skip to content

ReadMe is misleading about the behavior of PassParser #151

Description

@nicoledow

Please see this thread for further context on this issue.

Environment

  • decanter version: 4.0.4
  • ruby version: N/A
  • rails version: N/A

Expected Behavior

Given that PassParser allows an array (and the specs) indicate that this is intended behavior.

The ReadMe should indicate that an array can be passed to PassParser.

Current Behavior

The ReadMe indicates that ArrayParser is the only parser that accepts an array.

Decanter comes with the following parsers out of the box:

- `:boolean`
- `:date`
- `:date_time`
- `:float`
- `:integer`
- `:pass`
- `:phone`
- `:string`
- `:array`

Note: these parsers are designed to operate on a single value, except for `:array`. This parser expects an array, and will use the `parse_each` option to call a given parser on each of its elements:

Steps to Reproduce

N/A

Suggested Solution

Update the ReadMe to specify that an array can be passed to PassParser, which will simply return the array.

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions