I've gotten feedback and typo correction notices from @catherinezucker, @hdiamondlowe, and @guillochon on the docs. This is just collecting some of the things I want to add in one place:
[ ] Add in some examples concerning advanced usage of the various utilities (quantiles, simulating errors, merging runs).
[ ] Add in more documentation about advanced manipulation of the results (selecting particles, particle tracking, information).
[ ] Add in an example of KDE smoothing manipulation after it's implemented.
[ ] Add in "rules of thumb" about when/where to use various bounding methods.
[ ] Add in a more thorough description within the results object API (@pacargile).
[ ] Add in a thorough demonstration of importance reweighting after implementation.
[ ] Add in additional examples of using the generator functionality, especially with the dynamic sampler.
[ ] Change _quantile so it's no longer internal since enough people probably will want to use it. Also add an example of its application.
[ ] Add matplotlib version info to FAQ.
[ ] Add more examples for prior_transform.
[ ] Check that h is properly switched over to information.
[ ] Add in rwalk adjustment FAQ.
[ ] Add in an example of changing up the print statements using the new custom functionality (and update the docs accordingly to deal with the change).
[ ] Update the plots and their corresponding descriptions.
[ ] Add KDE speed in FAQ.
[ ] Add in examples using the new slice sampling options.
[ ] Elaborate on adding in the final set of live points so that users are clear(er) about it.
[ ] Add in part to the FAQ/docs to reassure users when the logzerr evaluates to nan and when logl_bounds evaluating to -np.inf.
[ ] Add in "What Sampling/Bounding Option Should Work For Me?" section emphasizing users should check out bounding/sampling options before running. Make this prominent in the docs so it's hard to miss.
I've gotten feedback and typo correction notices from @catherinezucker, @hdiamondlowe, and @guillochon on the docs. This is just collecting some of the things I want to add in one place:
prior_transform
.h
is properly switched over toinformation
.rwalk
adjustment FAQ.nan
and whenlogl_bounds
evaluating to-np.inf
.