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
/** * Generic validation method to ensure a specific key on a specific OS * object is either a string, or removed. * * @example * options = validateOptionalString(options, 'windows', 'comment'); * * @param {object} options User's options * @param {string} operatingSystem 'windows', 'linux', or 'osx' * @param {string} key The key within the OS object to be validated as an optional string * @return {object} Validated or mutated user options */validateOptionalString: function(options,operatingSystem,key){//...returnoptions;},
Notice that there is a clear separation between the method description, example, and param/return. The tag-lines rule treats @example the same as all other tags. But it looks messy without the extra return after the example.
Can we get a option for the tags to apply this to, maybe like how check-line-alignment does it?
The text was updated successfully, but these errors were encountered:
I have a lot of code like this:
Notice that there is a clear separation between the method description, example, and param/return. The
tag-lines
rule treats@example
the same as all other tags. But it looks messy without the extra return after the example.Can we get a option for the tags to apply this to, maybe like how
check-line-alignment
does it?The text was updated successfully, but these errors were encountered: