Add a tag for side effects
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
I would need to tag when a function has side effects, say with:
@sideEffects: console.log, fs.writefile
Expected behavior
This is supposed to be an array of strings or links to functions documentation within the same code base or externally, or both.
@sideEffects: console.log, fs.writefile
or
@side_effects: console.log, {@link https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback|fs.writefile}
It could be abbreviated as @sfx:
@sfx: console.log, fs.writefile
Related issues:
- probably #833
- @modifies doesn't seem to apply here
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing @modifies behavior and the related issues #833 and #1283 to understand the intended distinction. Confirm how a new tag, its @sfx abbreviation, arrays of strings, and internal or external function links should be represented; done means the agreed syntax is documented and generated correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100