Skip to content

Commit 96e4e21

Browse files
committed
Update docstring
1 parent f482bda commit 96e4e21

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

cmdstanpy/compiler_opts.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,15 @@ def compose_stanc(self, filename_in_msg: Optional[str]) -> List[str]:
300300
return opts
301301

302302
def compose(self, filename_in_msg: Optional[str] = None) -> List[str]:
303-
"""Format makefile options as list of strings."""
303+
"""
304+
Format makefile options as list of strings.
305+
306+
Parameters
307+
----------
308+
filename_in_msg : str, optional
309+
filename to be displayed in stanc3 error messages
310+
(if different from actual filename on disk), by default None
311+
"""
304312
opts = [
305313
'STANCFLAGS+=' + flag.replace(" ", "\\ ")
306314
for flag in self.compose_stanc(filename_in_msg)

0 commit comments

Comments
 (0)