-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Added component Validator section #5661
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
Conversation
ping @mvhirsch |
.. index:: | ||
single: Validator; Built In validators | ||
|
||
Built In validators |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
validators -> Validators ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hum ... better to say "Built in validators", what do you think ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be Validators (and below as well). In the docs, we use this title case standard: Capitialize every word except from closed-class words. "Validators/Validation" are not closed class words and have to be capitialized.
Thanks @mickaelandrieu! Do you plan to fill the empty articles in the diff before this PR can be merged? (otherwise, I propose to remove the empty files) |
@wouterj thanks for review, I will improve my work tonight. I have question on what did you expect to see in Metadata section ? I will fill the empty articles if we agree to the suggested plan, or I can remove theses to get this first pull request OK: as you like :) |
b80637b
to
5899d23
Compare
when will the first part of this PR be available for review/merge? |
@OskarStark I think I need to remove empty sections and this will be ready to merge. I'll ping you when it's done :) |
thank you @mickaelandrieu |
What can we do to help this get merged? We recently deleted the old README files for all components, so at the moment there are no docs for the Validator component. This is causing troubles for some users (see symfony/symfony#18108). |
@javiereguiluz I'll remove empty sections and rebase against master branch during the weekend. |
@javiereguiluz any reason why the intro docs were removed? They're very usefull (even for already documented components)... |
@javiereguiluz I don't have time to give some love on this old contribution, sorry. I agree to let someone else finish it. |
@mickaelandrieu don't worry! I totally understand. As I said, trying to write the entire documentation for a component is a big mistake. It's better to bootstrap a small introduction and a basic example. Then merge it and improve it. Trying to do everything at once is too much. |
@javiereguiluz I do agree, was entirely my fault to not finish it when I had time to do :/ What can we keep on this contribution to make it merged in your opinion ? If I only had to remove empty section and keep it "as it" it's ok to me, I can do it now. Tell me 🐈 |
@mickaelandrieu thank you very much for working on this. To move things forwards, I've created #6584 to finish your work and do some tweaks. Of course I've reused your original commits, so you'll get full credit for your work. |
Closing in favour of #6584 then. Thanks for kicking this off @mickaelandrieu! |
This pull request is the first from a series that provide a complete documentation for the Validator component.
For now, Installation and Introduction parts will be added, and others sections will refers to the Validator chapters of the Book as suggested by @wouterj .