OpenFn / OpenFn/adaptors

common: deprecate dataValue

Open
#484 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
24
Forks
41
Avg merge
3d 13h
Merged PRs (30d)
12

Description

And maybe some similar functions (sourceValue? asData?) - although we have to be careful that they are not used internally.

I don't think they're particularly useful in modern job writing and should be de-listed, removing clutter from the docs.

Another approach to these would be to mark them private, so they're just hidden from docs.

As part of this work, we need to go through the docs and remove example code that uses dataValue

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the repository for dataValue, sourceValue, and asData, including documentation examples, and check whether they are used internally. Clarify whether the functions should be deprecated, made private, or both. Done means the chosen API treatment is applied without breaking internal usage and documentation examples no longer use dataValue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.