You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a preference, I believe it is best practice to hace concise descriptions. However, there are often times when more details on a function or mixin benefit documenting complex behaviour.
I would suggest a @remarks annotation be provide for these cases. This concept exists in Microsoft's XMLDocs and might serve as a reference to this feature and usage.
///
/// Removes all values from a `$list` at `$index` onward an `$amount` of positions.
///
/// @param {List} $list - List containing the value to be removed.
/// @param {Number} $index - Index indicating the first value to be removed.
/// @param {Number} $amount - Number indicating the amount of positions to be removed
/// from the `$index`.
///
/// @return {List} - Returns a new list without the specified `$index`.
///
/// @remarks This function accepts negatives values for `$index` and `$amount` and will
/// traverse backward when negatives are provide. For example, [etc. ...]
///
The text was updated successfully, but these errors were encountered:
As a preference, I believe it is best practice to hace concise descriptions. However, there are often times when more details on a function or mixin benefit documenting complex behaviour.
I would suggest a
@remarks
annotation be provide for these cases. This concept exists in Microsoft's XMLDocs and might serve as a reference to this feature and usage.The text was updated successfully, but these errors were encountered: