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 @remarks to supplement DESCRIPTION #527

Open
roydukkey opened this issue Sep 28, 2018 · 1 comment
Open

Add @remarks to supplement DESCRIPTION #527

roydukkey opened this issue Sep 28, 2018 · 1 comment

Comments

@roydukkey
Copy link
Contributor

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. ...]
///
@steffenpedersen
Copy link

This is a great idea. We will definitely use that in further development.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants