Skip to content

Commit c498a3c

Browse files
committed
finish off some final todos
1 parent cfb12c6 commit c498a3c

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/source/fitting.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ normalized probability distribution is obtained.
328328
The measured timing solution is then interpolated onto this distribution,
329329
computing a final likelihood value, for this pulsar. All pulsars in the cluster
330330
have their likelihoods summed in the usual manner.
331+
331332
.. TODO DM stuff
332333
333334

docs/source/ref/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ API
44

55
This page details the methods and classes provided by the ``GCfit`` module.
66

7-
TODO seems like the autogen is duplicating all the methods in classes
7+
.. TODO this imaage needs to be updated since nested classes were split off
88
99
.. image:: package-structure.png
1010

fitter/core/data.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,7 @@ def _determine_likelihoods(self):
645645

646646
# TODO The units are *quite* incomplete in Model (10)
647647
# TODO would be cool to get this to work with limepy's `sampling`
648+
# TODO what attributes should be documented?
648649

649650
class Model(lp.limepy):
650651
r'''Wrapper class around a LIMEPY model, including mass function evolution
@@ -666,7 +667,8 @@ class Model(lp.limepy):
666667
theta : dict or list
667668
The model input parameters. Must either be a dict, or a full list of
668669
all parameters, in the exact same order as `DEFAULT_INITIALS`.
669-
See {{TODO docs}} for explanation of all possible input parameters.
670+
See package background documentation for explanation of all possible
671+
input parameters.
670672
671673
observations : Observations, optional
672674
The `Observations` instance corresponding to this cluster. While not
@@ -685,8 +687,6 @@ class Model(lp.limepy):
685687
{BH,NS,WD}_Nj : astropy.Quantity
686688
Black hole, neutron star or white dwarf total bin number (Mj / mj)
687689
688-
# TODO none of the other important attributes were documented
689-
690690
Notes
691691
-----
692692
The IMF of the model is defined using a three-component broken power law,

0 commit comments

Comments
 (0)