search

steph1111 / PRECISE

Precision Rules Enforced Calculations In Scientific Environments
Other
0 stars 0 forks source link

sig_float: Update function comments #41

Closed steph1111 closed 1 year ago

steph1111 commented 1 year ago

Function comments should be formatted as follows:

    """
    Format a string representation of a number with scientific notation surpressed

    Parameters:
      x : str 
        The value to be formatted
      sig_figs : int 
        The number of sig_figs 'x' has

    Returns:
      A formatted string representation of x in standard notation 
    """