Skip to content
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.

Sign up for GitHub

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

Fix some documentation rendering for pylibcudf #17217

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Fix some documentation rendering for pylibcudf #17217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix some documentation rendering for pylibcudf
  • Loading branch information
@mroeschke
mroeschke committed Oct 30, 2024
commit f1707fd66d7c00732a60b7eb5abe5ed0ef056969
6 changes: 3 additions & 3 deletions docs/cudf/source/user_guide/api_docs/pylibcudf/strings/findall.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
====
find
====
=======
findall
=======

.. automodule:: pylibcudf.strings.findall
:members:
2 changes: 1 addition & 1 deletion docs/cudf/source/user_guide/api_docs/pylibcudf/table.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=====
Table
table
=====

.. automodule:: pylibcudf.table
Expand Down
1 change: 1 addition & 0 deletions python/pylibcudf/pylibcudf/binaryop.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ cpdef bool is_supported_operation(
The right hand side data type.
op : BinaryOperator
The operation to check.

Returns
-------
bool
Expand Down
5 changes: 5 additions & 0 deletions python/pylibcudf/pylibcudf/filling.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ cpdef void fill_in_place(
The index at which to stop filling.
value : Scalar
The value to fill with.

Returns
-------
None
"""

with nogil:
Expand All @@ -101,6 +105,7 @@ cpdef Column sequence(size_type size, Scalar init, Scalar step):
The initial value of the sequence
step : Scalar
The step of the sequence

Returns
-------
pylibcudf.Column
Expand Down
1 change: 1 addition & 0 deletions python/pylibcudf/pylibcudf/strings/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"capitalize",
"case",
"char_types",
"combine",
"contains",
"convert",
"extract",
Expand Down
4 changes: 4 additions & 0 deletions python/pylibcudf/pylibcudf/strings/regex_program.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ cdef class RegexProgram:
flags : Uniont[int, RegexFlags]
Regex flags for interpreting special characters in the pattern

Returns
-------
RegexProgram
A new RegexProgram
"""
cdef unique_ptr[regex_program] c_prog
cdef regex_flags c_flags
Expand Down
1 change: 1 addition & 0 deletions python/pylibcudf/pylibcudf/strings/replace.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ cpdef Column replace_slice(
Start position where repl will be added.
stop : size_type, default -1
End position (exclusive) to use for replacement.

Returns
-------
pylibcudf.Column
Expand Down
10 changes: 10 additions & 0 deletions python/pylibcudf/pylibcudf/types.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,16 @@ cpdef size_type size_of(DataType t):
Only fixed-width types are supported.

For details, see :cpp:func:`size_of`.

Parameters
----------
t : DataType
The DataType to get the size of.

Returns
-------
int
Size in bytes of an element of the specified type.
"""
with nogil:
return cpp_size_of(t.c_obj)
Expand Down
Loading