-
Notifications
You must be signed in to change notification settings - Fork 3.9k
MINOR: Update null values documentation in csv.rst
#48048
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Expanded the default list of recognized null spellings in the documentation.
|
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format? or See also: |
csv.rst
|
@github-actions crossbow submit preview-docs |
|
Revision: 7945ea3 Submitted crossbow builds: ursacomputing/crossbow @ actions-d7b30c40c1
|
raulcd
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, it feels too specific to me and prone to getting outdated soon if we end up doing any other spelling. I am not sure this is something we want to add to the documentation.
@AlenkaF @thisisnic thoughts?
In any case the linter is failing because those require double backticks ``""`` instead of single `""`
See rendered docs not showing correctly here:
http://crossbow.voltrondata.com/pr_docs/48048/cpp/csv.html#nulls
Hi, thanks for the reply. My initial motivation is that I found it was hard to find the specific null spelling (also for |
|
It is a bit of a paint to find relevant information for this specific case. What if we update the header file here: arrow/cpp/src/arrow/csv/options.h Lines 130 to 132 in 5eaf553
with additional information about what are "default null values" (plus others) and then link the API docs section here: to the Nulls section in the User Guide? Adding such a specific list directly to the docs does look like a possible future issue with outdated information. |
Hi, I've reverted the doc change and update the header file as suggested. Please take a look. |
| /// Create conversion options with default values, including conventional | ||
| /// values for `null_values`, `true_values` and `false_values` | ||
| /// | ||
| /// Default null values: see http://crossbow.voltrondata.com/pr_docs/48048/cpp/csv.html#nulls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can not link to the preview docs. Here, in the header file, we can actually add the list of the conventional null values. Then this section can be linked from the csv.html.
Rationale for this change
Explicitly showing the default null spellings in the document would be convenient.
Source:
arrow/cpp/src/arrow/csv/options.cc
Lines 38 to 47 in 5eaf553
What changes are included in this PR?
Only the document.
Are these changes tested?
No need to test.
Are there any user-facing changes?
No.