bahmutov / bahmutov/xplain

document example unit test transform code workflow

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
docs enhancement
Dominant language
JavaScript
Stars
28
Forks
1
PR merge metrics
No merged PRs in 30d

Description

- expose unit test transform function

For external user:
- create object with name, code function
- run transform that will output code function changed into human readable format. Might need unit testing framework name

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the transform function and the existing example API documentation in the repository. Clarify how an external user should create the named object, provide its code function, and run the transform; done means that workflow is documented and produces a human-readable result, including the unit-testing framework guidance if needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.