ericelliott / ericelliott/rtype

`effects` keyword to describe side-effects

Open
#125 1 comment 1 reaction 0 assignees View on GitHub
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.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.