TOVsolver.solver_code.TOV_def documentation return type is unclear or incorect

[rhaas80]

The docs https://chunhuangphy.github.io/CompactObject/TOV_solver.html#TOVsolver.solver_code.TOV_def state

Returns:

The array that contains all the Stars’ masses, in M_sun as a Units.
Radius (array): The array that contains all the Stars’s radius, in km.
Tidal Deformability (array): The array that contains correpsonding Tidal property, These are dimension-less.

Return type:

Mass (array)

so "Returns" mentions multiple arrays but "Return type" only the first (Mass). The code itself return an array with four elements:

return np.array([dpdr, dmdr, dhdr, dfdr])

[tuhinbits]

Thank you for identifying these documentation issues, @rhaas80.

You're absolutely right - the documentation for TOV_def has several problems:

1. It incorrectly mentions an equation parameter that doesn't exist in the actual function signature
2. It contains the typo "psudo-varible" instead of "pseudo-variable"
3. The inveos parameter description is confusing and poorly formatted
4. The ad_index parameter is completely missing from the documentation

I've corrected the docstring to properly match the function signature and provide clear descriptions:

def TOV_def(r, y, inveos, ad_index):
    """Packs the complete set of TOV equations for neutron stars with tidal deformability

    Args:
        r (float): Radius as integration variable
        y (array): Array of integration variables containing [pressure, mass, h, b]
            where h and b are variables used for tidal deformability calculation
        inveos (function): Inverse equation of state function that maps pressure to energy density
        ad_index (float): Adiabatic index used in the tidal deformability equations

    Returns:
        array: Array containing derivatives [dpdr, dmdr, dhdr, dfdr] for the integration
    """

This revised documentation now correctly reflects all parameters, their types, and their purposes in the function. The return value is also properly documented.

Thank you for your thorough review - these kinds of documentation improvements are valuable for code maintainability and new user onboarding.