mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-04-25 01:05:55 +03:00
[GH-ISSUE #85] Consider using JSDoc-style function annotations everywhere #70
Labels
No labels
bug
enhancement
enhancement
enhancement
fixed in next
fixed in next
fixed in next
new rule
new rule
new rule
pull-request
question
refactoring
refactoring
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/markdownlint#70
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @JoshuaKGoldberg on GitHub (Oct 30, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/85
Editors like Atom and VS Code will give better experiences when functions declare what their input and output types are.
Now:
With proper JSDoc:
@DavidAnson commented on GitHub (Oct 30, 2017):
I do so for public functions, see
function markdownlintfor example. I have a note to look into// @ts-check(https://code.visualstudio.com/docs/languages/javascript) which would complement this for private functions.@JoshuaKGoldberg commented on GitHub (Oct 30, 2017):
👍. Title changed.