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

Improvements to API documentation #62

Closed
4 tasks
drbenvincent opened this issue Nov 15, 2022 · 1 comment
Closed
4 tasks

Improvements to API documentation #62

drbenvincent opened this issue Nov 15, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@drbenvincent
Copy link
Collaborator

drbenvincent commented Nov 15, 2022

  • Elaborate on the skl_models.WeightedProportion model docstring
  • Elaborate the docstrings for each of the quasi experiment design categories
  • In causalpy.pymc_experiments.RegressionDiscontinuity docstring, clarify that this is a parametric approach. This contrasts to the non-parametric approaches which examines datapoints within a certain bandwidth of the threshold.
  • Remove plot_utils from the autodoc as this is not part of the user facing API
@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Nov 15, 2022
@drbenvincent drbenvincent added this to the Stabilise the backend milestone Dec 5, 2022
@drbenvincent
Copy link
Collaborator Author

Closing because this was dealt with by #232

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

No branches or pull requests

1 participant