ericelliott / ericelliott/rtype
`effects` keyword to describe side-effects
Open
enhancement
proposal
- Dominant language
- JavaScript
- Stars
- 1.1k
- Forks
- 38
- PR merge metrics
- No merged PRs in 30d
Description
A way to describe side-effects in prose for documentation purposes, e.g.:
```
log(value) => Void, effects( log to console )
```
You can spread the description over multiple lines:
```
log(value) => Void, effects(
log to console,
POST to logging server
)
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.