final-form / final-form/final-form

Question: Why isn't setConfig documented?

Open
#392 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
3k
Forks
225
PR merge metrics
No merged PRs in 30d

Description

I came across `FinalForm.setConfig()` while browsing the code and it comes in very handy. I wonder why it is not present in the documentation? Is it intended to be used internally only? Simply forgot? I'd be happy to file a PR to add it, but I wanted to understand first.

P.S.: Thanks for the great lib! Been using it for a few years now (redux-form) and I am now migrating to final-form.

Contributor guide

Open the contributing guide

Research direction

Start by locating `FinalForm.setConfig()` in the code and inspecting how it is used to determine whether it is public or internal. Check the existing documentation structure, then confirm that the intended status and purpose of `setConfig()` are recorded clearly if it belongs in the public API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.