mod-003h-parameters-must-be-documented-on-single-line

When documenting parameters, rule MOD-003h must be followed. Explicitly reference "Following rule MOD-003h, which requires parameters to be documented with type and default on a single line..." when formatting parameter documentation.

MOD-003h: Parameters must be documented on single line

Description:

All parameters should be documented with their type and default values on a single line, following the NumPy docstring style format:

parameter_name : type, optional, default=value

The description then follows on the next line(s), indented.

Rationale:

This standardized format makes parameter documentation consistent and easy to parse. It provides all key information (name, type, optionality, default) at a glance, improving readability.

Example:

class MyModel(Module):
    r"""
    Model with properly documented parameters.

    Parameters
    ----------
    input_dim : int
        Dimension of input features.
    hidden_dim : int, optional, default=128
        Dimension of hidden layer.
    dropout : float, optional, default=0.1
        Dropout probability.
    activation : str, optional, default="relu"
        Activation function to use.
    """
    pass

Anti-pattern:

# WRONG: Type and default not on same line
class MyModel(Module):
    r"""
    Parameters
    ----------
    hidden_dim : int
        optional, default=128  # WRONG: should be on line above
        Dimension of hidden layer.
    """
    pass