Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add newlines between tag types #953

Open
smol-ninja opened this issue Jun 21, 2024 · 0 comments
Open

Add newlines between tag types #953

smol-ninja opened this issue Jun 21, 2024 · 0 comments
Labels
effort: low Easy or tiny task that takes less than a day. priority: 3 Nice-to-have. Willing to ship without this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.

Comments

@smol-ninja
Copy link
Member

smol-ninja commented Jun 21, 2024

Discussed in #906

Add newlines between tag types to improve readability.

/// @notice Creates a new MerkleLockup campaign with a LockupLinear distribution.
/// @dev Emits a {CreateMerkleLL} event.
/// @param baseParams Struct encapsulating the {SablierV2MerkleLockup} parameters, which are documented in
/// {DataTypes}.
/// @param lockupLinear The address of the {SablierV2LockupLinear} contract.
/// @param streamDurations The durations for each stream.
/// @param aggregateAmount The total amount of ERC-20 assets to be distributed to all recipients.
/// @param recipientCount The total number of recipients who are eligible to claim.
/// @return merkleLL The address of the newly created MerkleLockup contract.

becomes

/// @notice Creates a new MerkleLockup campaign with a LockupLinear distribution.
///
/// @dev Emits a {CreateMerkleLL} event.
///
/// @param baseParams Struct encapsulating the {SablierV2MerkleLockup} parameters, which are documented in
/// {DataTypes}.
/// @param lockupLinear The address of the {SablierV2LockupLinear} contract.
/// @param streamDurations The durations for each stream.
/// @param aggregateAmount The total amount of ERC-20 assets to be distributed to all recipients.
/// @param recipientCount The total number of recipients who are eligible to claim.
///
/// @return merkleLL The address of the newly created MerkleLockup contract.
@smol-ninja smol-ninja added type: docs Changes to documentation. effort: low Easy or tiny task that takes less than a day. work: clear Sense-categorize-respond. The relationship between cause and effect is clear. priority: 3 Nice-to-have. Willing to ship without this. labels Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: low Easy or tiny task that takes less than a day. priority: 3 Nice-to-have. Willing to ship without this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.
Projects
None yet
Development

No branches or pull requests

1 participant