Make it clear whether a function is an Operation or just a Function
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 20
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 6
Description
Adaptors export a bunch of functions to be used in job code.
Most of these functions are Opertions - outside of common, probably 99% of them are operations.
But some are just functions,
Operations and functions should be treated slightly differently by end users (see #428), so some kind of operation label/pill on the adaptor docs, or maybe a show operations only checkbox on the docs page, would be really helpful.
It would also be nice for users to see the docs and say "hey, what's this operation stuff all about?" and see a link to a really clear explanation.
Contributor guide
No contributing guide indexed for this repository
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 adaptor documentation page and the distinction described in issue #428. Decide whether the change should use operation labels, an operations-only filter, or both, then document the concept clearly and verify that users can distinguish operations from ordinary functions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100