Clarify usage of `set_bridgestan_path` in examples

roualdes / bridgestan

BridgeStan provides efficient in-memory access through Python, Julia, and R to the methods of a Stan model.

https://roualdes.github.io/bridgestan

BSD 3-Clause "New" or "Revised" License

88 stars 12 forks source link

Clarify usage of `set_bridgestan_path` in examples #157

Closed WardBrian closed 1 year ago

WardBrian commented 1 year ago

Closes #156

roualdes commented 1 year ago

I agree this is a doc issue. The updated language makes sense to me, but I'm not really the intended audience. @gil2rok, what do you think of these additional comments in the doc and the examples? Do you imagine these changes would have helped you understand what we have in mind for the use case of set_bridgestan_path()?

gil2rok commented 1 year ago

Yes, this type of comment would have helped clarify when / how to use set_bridgestan_path(). Thanks!