search

sablier-labs / v2-core

⏳ Core smart contracts of the Sablier V2 token distribution protocol
https://sablier.com
Other
289 stars 38 forks source link

Rename Helpers functions #847

Closed andreivladbrg closed 3 months ago

andreivladbrg commented 3 months ago

These functions include "check" in theirs name, but we don't actually check anything; we only calculate the segments/tranches.

Therefore, should we rename it to calculateSegmentTimestamps and calculateTrancheTimestamps respectively?

https://github.com/sablier-labs/v2-core/blob/cbe1c0d61d74217d6ad01599318d5551f3381b2b/src/libraries/Helpers.sol#L143

https://github.com/sablier-labs/v2-core/blob/cbe1c0d61d74217d6ad01599318d5551f3381b2b/src/libraries/Helpers.sol#L176

PaulRBerg commented 3 months ago

Good catch

should we rename it to calculateSegmentTimestamps and calculateTrancheTimestamps respectively?

Yes

PaulRBerg commented 3 months ago

Can you please add type: labels

andreivladbrg commented 3 months ago

should we rename it to calculateSegmentTimestamps and calculateTrancheTimestamps respectively? Yes

should we use plural instead? calculateSegmentsTimestamps and calculateTranchesTimestamps

PaulRBerg commented 3 months ago

Singular is OK in this situation