Skip to content

Commit

Permalink
Fix incorrect strings_column_view::chars_size documentation (#7360)
Browse files Browse the repository at this point in the history
The documentation for `strings_column_view::chars_size` claims that it handles sliced columns when it does not.
This updates the documentation to reflect that it does not account for a sliced column view.

Authors:
  - Jason Lowe (@jlowe)

Approvers:
  - Vukasin Milovanovic (@vuule)
  - David (@davidwendt)
  - Mark Harris (@harrism)
  - Devavret Makkar (@devavret)

URL: #7360
  • Loading branch information
jlowe authored Feb 10, 2021
1 parent c0282e6 commit 74a7c76
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions cpp/include/cudf/strings/strings_column_view.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2019-2020, NVIDIA CORPORATION.
* Copyright (c) 2019-2021, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -78,8 +78,8 @@ class strings_column_view : private column_view {
/**
* @brief Returns the number of bytes in the chars child column.
*
* This accounts for the offset of the strings' column_view and
* for empty columns.
* This accounts for empty columns but does not reflect a sliced parent column
* view (i.e.: non-zero offset or reduced row count).
*/
size_type chars_size() const noexcept;
};
Expand Down

0 comments on commit 74a7c76

Please sign in to comment.