joshspeagle / dynesty

Dynamic Nested Sampling package for computing Bayesian posteriors and evidences
https://dynesty.readthedocs.io/
MIT License
357 stars 77 forks source link

Error in documentation #133

Closed gapplef closed 5 years ago

gapplef commented 5 years ago

logl_args, ptform_args (parameters of NestedSampler/DynamicNestedSampler) are explained as dict in documentation, which not correct in my test.

logl_args : dict, optional
    Additional arguments that can be passed to loglikelihood.

logl_kwargs : dict, optional
    Additional keyword arguments that can be passed to loglikelihood.

ptform_args : dict, optional
    Additional arguments that can be passed to prior_transform.

ptform_kwargs : dict, optional
    Additional keyword arguments that can be passed to prior_transform.
joshspeagle commented 5 years ago

Good catch -- that's just me copy-pasting too much when writing all these out. I'll fix it with the next release.