Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing information on what functions return in the Docs #604

Open
ivosabev opened this issue Apr 26, 2024 · 1 comment
Open

Missing information on what functions return in the Docs #604

ivosabev opened this issue Apr 26, 2024 · 1 comment

Comments

@ivosabev
Copy link

ivosabev commented Apr 26, 2024

Describe the bug and the expected behavior

For example here: https://conform.guide/api/zod/parseWithZod

There is only information on what parameters the function takes, but nothing on what it returns and their types.

Doing a simple console log in your code gets you more info, but for this particular function for example there are two values - payload and value and unless I go inside the conform codebase there is no way for me to tell which are the parsed values and which is the raw values.

It is the same for most other functions useForm is another example.

useField has some very basic return info, but it is not presented in the best way. Just as in the Parameters section it is missing the type, is it a string, is it a boolean, is it a function, if it is a function what is the shape of that function.

The library looks great, so improving on those will make it even greater and easier to use.

@BenAHammond
Copy link

👍 +1 for more detailed types and documentation for the api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants