Skip to content

Document distinction of YAML multiple documents vs sequence/array of valuesΒ #133

Open
@cowtowncoder

Description

@cowtowncoder

(see #132 for background)

So: handling of a single physical document containing multiple logical documents is quite specific in that one has to use mapper.readValues() to deal with it, and can not use regular readValue() to bind as collections (for example). There are technical reasons for this difference but it is not necessarily clear from user perspective this is a different use case.

So this should be somehow documented. An immediate place is probably on README for YAML module, but perhaps something could be added to readValues() method too, to mention it does not just related to root-level JSON values (like "linefeed-separate JSON") but also more generally to some other data formats.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssue related to (lack of) documentationgood first issueIssue that seems easy to resolve and is likely a good candidate for contributors new to projectyamlIssue related to YAML format backend

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions