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

Doc tweaks: Arrange FormState's properties in cagtegories #462

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

honey32
Copy link

@honey32 honey32 commented Sep 15, 2022

Hello.
I really appreciate this lib's reasonable and simple design.
Let me contribute on improving docs for our better understanding and wider spreading.

Background

I have difficulty on understanding the outline of the FormState type document.
Especially, it is very hard to visualize in mind the relation between each properties

for example,

  • pristine === !dirty
  • hasXErrors for existence of any error (to prevent submit)
    • xError only for whole form error
    • xErrors for errors in fields

Honestly, I think doc's comprehensibility is a big problem and barrier for me to introduce this lib for my co-worker or Japanese brothers/sisters.

To confess, until this work, I didn't understand the whole picture of relations.

What I did in this PR

  • I arranged the properties into some groups
  • I added some pseudo code to visualize the relations

Preview in Github

Preview in Github

@honey32 honey32 changed the title Doc improvements: Make FormState's properties cagtegorized Doc improvements: Arrange FormState's properties in cagtegories Sep 15, 2022
@honey32 honey32 changed the title Doc improvements: Arrange FormState's properties in cagtegories Doc tweaks: Arrange FormState's properties in cagtegories Sep 22, 2022
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

Successfully merging this pull request may close these issues.

None yet

1 participant