Skip to content

Commit

Permalink
Properly enable Cython docstrings. (#1020)
Browse files Browse the repository at this point in the history
This PR embeds signatures in Cython functions and classes so that they'll be accessible for normal Python help. While docstrings are currently present as expected, we still have to provide Cython with the appropriate directives to tell it that we want signatures.

Authors:
  - Vyas Ramasubramani (https://github.com/vyasr)

Approvers:
  - Ashwin Srinath (https://github.com/shwina)
  - Bradley Dice (https://github.com/bdice)

URL: #1020
  • Loading branch information
vyasr authored Apr 7, 2022
1 parent 921d286 commit 23d98ba
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion python/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@

cmake_minimum_required(VERSION 3.20.1 FATAL_ERROR)

# TODO: Pull this directly from the file written by rapids_cmake_write_version_file.
set(rmm_version 22.06.00)

set(CYTHON_FLAGS
"--directive binding=True,embedsignature=True,always_allow_keywords=True"
CACHE STRING "The directives for Cython compilation.")

project(
rmm-python
VERSION ${rmm_version}
Expand Down

0 comments on commit 23d98ba

Please sign in to comment.