dotnet / dotnet/machinelearning

SaveAsText documentation doesn't address scope of separator argument

Open
#2,512 0 comments 0 reactions 0 assignees View on GitHub
area-Core Priority:2
Dominant language
C#
Stars
9.4k
Forks
2k
Avg merge
2d 20h
Merged PRs (30d)
11

Description

`SaveAsText` in the `Data` catalog has a `separator` parameter, which is specified as a `char`. However, this throws an `ArgumentOutOfRangeException` if the `separator` is not a "space, tab, comma, semicolon, or bar".

Currently, the only way to discover this delimiter limitation is to try and fail.

We have a few options. We could allow any character to be used as a delimiter, we could add documentation to the parameter that says it must be one of these characters, or, if we really do want to scope to a limited set of characters, then we could add a compile-time check by changing this to an `enum`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.