From 74a7c7631883c52d230f1642bb6b04a1fbd4c819 Mon Sep 17 00:00:00 2001 From: Jason Lowe Date: Tue, 9 Feb 2021 23:00:27 -0600 Subject: [PATCH] Fix incorrect strings_column_view::chars_size documentation (#7360) 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: https://github.com/rapidsai/cudf/pull/7360 --- cpp/include/cudf/strings/strings_column_view.hpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cpp/include/cudf/strings/strings_column_view.hpp b/cpp/include/cudf/strings/strings_column_view.hpp index 2be565fc386..0c7270b3ba8 100644 --- a/cpp/include/cudf/strings/strings_column_view.hpp +++ b/cpp/include/cudf/strings/strings_column_view.hpp @@ -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. @@ -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; };