"""
Blocks of text for assembling docstrings.
"""

parameters = dict(
SP = "Practical Salinity (PSS-78), unitless",
SA = "Absolute Salinity, g/kg",
SR = "Reference Salinity, g/kg",
SK = "Knudsen Salinity, ppt",
Sstar = "Preformed Salinity, g/kg",
SA_seaice =
"""Absolute Salinity of sea ice: the mass fraction of salt
in sea ice, expressed in g of salt per kg of sea ice.""",
t_seaice =
"In-situ temperature of the sea ice at pressure p (ITS-90), degrees C",
t = "In-situ temperature (ITS-90), degrees C",
Rt = "C(SP,t_68,0)/C(SP=35,t_68,0), unitless",
CT = "Conservative Temperature (ITS-90), degrees C",
C = "Conductivity, mS/cm",
p = "Sea pressure (absolute pressure minus 10.1325 dbar), dbar",
lon = "Longitude, -360 to 360 degrees",
lat = "Latitude, -90 to 90 degrees",
saturation_fraction =
"Saturation fraction of dissolved air in seawater. (0..1)",
p_ref = "Reference pressure, dbar",
p_shallow = "Upper sea pressure (absolute pressure minus 10.1325 dbar), dbar",
p_deep = "Lower sea pressure (absolute pressure minus 10.1325 dbar), dbar",

enthalpy_diff = "Specific enthalpy, deep minus shallow, J/kg",
pot_enthalpy_ice =  "Potential enthalpy of ice, J/kg",
h = "Specific enthalpy, J/kg",
entropy = "Specific entropy, J/(kg*K)",
pt0 = "Potential temperature with reference pressure of 0 dbar, degrees C",
pt0_ice = "Potential temperature of ice (ITS-90), degrees C",
# TODO: Check the functions using this to see if any customizations are needed.
pt = "Potential temperature referenced to a sea pressure, degrees C",
rho = "Seawater density (not anomaly) in-situ, e.g., 1026 kg/m^3.",
t_Ih = "In-situ temperature of ice (ITS-90), degrees C",
z = "Height, positive up (so z = -depth), m",
SA_bulk = "bulk Absolute Salinity of the seawater and ice mixture, g/kg",
w_Ih =
"""mass fraction of ice: the mass of ice divided by the
sum of the masses of ice and seawater. 0 <= wIh <= 1. unitless.""",
w_seaice =
"""mass fraction of ice: the mass of sea-ice divided by the sum
of the masses of sea-ice and seawater. 0 <= wIh <= 1. unitless.""",
h_bulk =  "bulk enthalpy of the seawater and ice mixture, J/kg",
h_pot_bulk = "bulk enthalpy of the seawater and ice mixture, J/kg",
geo_strf_dyn_height = """dynamic height anomaly, m^2/s^2
    Note that the reference pressure, p_ref, of geo_strf_dyn_height must
    be zero (0) dbar.""",
sea_surface_geopotential = "geopotential at zero sea pressure,  m^2/s^2",
ns = "order of SA derivative, integer in (0, 1, 2)",
nt = "order of t derivative, integer in (0, 1, 2)",
np = "order of p derivative, integer in (0, 1, 2)",
)

return_overrides = dict(
    gibbs = [
    "gibbs : array-like",
    "    Specific Gibbs energy or its derivatives.",
    "    The Gibbs energy (when ns = nt = np = 0) has units of J/kg.",
    "    The Absolute Salinity derivatives are output in units of (J/kg) (g/kg)^(-ns).",
    "    The temperature derivatives are output in units of (J/kg) (K)^(-nt).",
    "    The pressure derivatives are output in units of (J/kg) (Pa)^(-np).",
    "    The mixed derivatives are output in units of (J/kg) (g/kg)^(-ns) (K)^(-nt) (Pa)^(-np).",
    "    Note: The derivatives are taken with respect to pressure in Pa, not",
    "    withstanding that the pressure input into this routine is in dbar.",
    ],
    gibbs_ice = [
    "gibbs_ice : array-like",
    "    Specific Gibbs energy of ice or its derivatives.",
    "    The Gibbs energy (when nt = np = 0) has units of J/kg.",
    "    The temperature derivatives are output in units of (J/kg) (K)^(-nt).",
    "    The pressure derivatives are output in units of (J/kg) (Pa)^(-np).",
    "    The mixed derivatives are output in units of (J/kg) (K)^(-nt) (Pa)^(-np).",
    "    Note. The derivatives are taken with respect to pressure in Pa, not",
    "    withstanding that the pressure input into this routine is in dbar.",
    ]
)