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

Make required arguments passed through ... explicit #125

Open
jamesmbaazam opened this issue Dec 12, 2023 · 0 comments
Open

Make required arguments passed through ... explicit #125

jamesmbaazam opened this issue Dec 12, 2023 · 0 comments
Labels
discussion help wanted Extra attention is needed

Comments

@jamesmbaazam
Copy link
Member

Some ... (e.g., in likelihood()) are passed to child functions several levels deep. This makes it very difficult to know which arguments this function is taking and where they are documented.

The nobs_offspring argument is a good example of that. It's required if you passed a distribution that epichains doesn't know but it's not really explicit from the function documentation. And as far as I can tell, you cannot arrive to the help page describing it from links in likelihood().
I am not yet completely sure about the solution for this. Maybe make these arguments explicit rather than implicit in the ellipses?

Originally posted by @Bisaloo in #122 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant