Add custom JSDoc "expects" tag #183
Labels
😌 code quality
For improvements to the syntax, structure, dependencies, etc...
🙌 community
By or for the library's community
📖 documentation
Regarding the documentation of a thing
Is your feature request related to a problem? Please describe.
Minimized code will have implicit assumptions baked into it. Ideally no assumptions would ever be made but this would create repeated work. So it's desirable to trust that arguments will conform to certain standards e.g. an array is sorted or a property is set
Describe the solution you'd like
As a way to make assumptions built into code explicit we could add a custom JSDoc
@assumption
that would go above the function declaration and render in the docs for a end-user consuming the softwareEdit: As a way to shorten the syntax and broaden the applicability of the tag we could use
@expects
for interface related assumptionsThe text was updated successfully, but these errors were encountered: