Skip to content

Commit 838f6b4

Browse files
committed
Update docstring
1 parent ea2fb59 commit 838f6b4

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

cmdstanpy/install_cmdstan.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,13 @@ def compile_example() -> None:
182182

183183
def rebuild_cmdstan(verbose: bool = True) -> None:
184184
"""
185-
Rebuilds the existing cmdstan installation
185+
Rebuilds the existing CmdStan installation.
186+
This assumes CmdStan has already been installed,
187+
though it need not be installed via CmdStanPy for
188+
this function to work.
189+
190+
:param verbose: Boolean value; when ``True``, output from CmdStan build
191+
processes will be streamed to the console. Default is ``False``.
186192
"""
187193
try:
188194
with pushd(cmdstan_path()):

0 commit comments

Comments
 (0)