Closed smol-ninja closed 3 months ago
I changed my mind about this. It does not look good when you have one notice, one dev, one param and one return.
/// @notice Calculates the amount that the sender owes on the stream, i.e. if more assets have been streamed than
/// its balance, denoted in 18 decimals. If there is no debt, it will return zero.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
/// @return debt The amount that the sender owes on the stream.
function streamDebtOf(uint256 streamId) external view returns (uint128 debt);
vs
/// @notice Calculates the amount that the sender owes on the stream, i.e. if more assets have been streamed than
/// its balance, denoted in 18 decimals. If there is no debt, it will return zero.
///
/// @dev Reverts if `streamId` references a null stream.
///
/// @param streamId The stream ID for the query.
///
/// @return debt The amount that the sender owes on the stream.
function streamDebtOf(uint256 streamId) external view returns (uint128 debt);
Its quite useful when you have multiple params
so that makes it a bit subjective. So I am happy to just refactor wherever are multiple params instead of doing it for all as a thumb rule.
For me it's the same for all, I don't have a preference, do as you wish.
Discussed in https://github.com/sablier-labs/v2-core/discussions/906
Add newlines between tag types to improve readability.
becomes