Visitar URL original
README.md outdated list of supported built-in types · Issue #2266 · MessagePack-CSharp/MessagePack-CSharp · GitHub
Skip to content

README.md outdated list of supported built-in types #2266

Closed

Description

@TheTonttu

Bug description

The list of built-in supported types in README.md is outdated or at least ambiguous.

Repro steps

Read the README.md, see no mention of DateOnly or TimeOnly.

Expected behavior

Reading README.md is enough to know what built-in (or otherwise) types are supported out of the box.

My rationale is that DateOnly and TimeOnly should be explicitly listed same way as the other date/time types at the moment,

Alternatively the phrasing could be made in broader terms like "Date/time types (TimeSpan, DateTime, DateTimeOffset, etc.)", but I don't think that helps the reader.

Actual behavior

Have to rummage through old release notes, issues, pull request, or code to find out what exact built-in types are supported.

Additional context

I was mainly trying to find out if DateOnly and TimeOnly were supported. There are probably other types that could use explicit mention, especially if they have been introduced in newer .NET versions.

Some serialization libraries do not support newer types, so in general it is sometimes unclear whether documentation is lacking or actual type is unsupported.

PS: Thanks for all the hard work maintaining the library. 😊

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions