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.

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

Update docstring to explain sample_kwargs + add intersphinx #207

Merged
merged 2 commits into from
Jun 13, 2023

Conversation

drbenvincent
Copy link
Collaborator

@drbenvincent drbenvincent commented Jun 13, 2023

  • Closes add option to choose sampler  #106 by adding info to the docstring to explain sample_kwargs
  • Also adds intersphinx, so we can now make clickable links that will take you through directly to the docs of other packages. So far, just PyMC.

Screenshot of local build of the docs:
Screenshot 2023-06-13 at 14 14 26

@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Jun 13, 2023
@codecov
Copy link

codecov bot commented Jun 13, 2023

Codecov Report

Merging #207 (2a1de92) into main (02d2506) will not change coverage.
The diff coverage is n/a.

❗ Current head 2a1de92 differs from pull request most recent head b58c4c2. Consider uploading reports for the commit b58c4c2 to get more accurate results

@@           Coverage Diff           @@
##             main     #207   +/-   ##
=======================================
  Coverage   70.34%   70.34%           
=======================================
  Files          19       19           
  Lines        1005     1005           
=======================================
  Hits          707      707           
  Misses        298      298           
Impacted Files Coverage Δ
causalpy/pymc_models.py 100.00% <ø> (ø)

@drbenvincent drbenvincent merged commit 678c915 into main Jun 13, 2023
@drbenvincent drbenvincent deleted the update-docstring branch June 13, 2023 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add option to choose sampler
1 participant