-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
ensure consistency with the note #4329
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
You are selecting forms by its submit button, that's what this section tries to explain. So -1 for this change. |
I can understand the proposal made by @greg0ire but I think @wouterj is right. Even if you do it indirectly, you are in fact selecting forms. By the way, should we add a note/comment about how to deal with forms that don't have submit buttons? I know this is very uncommon, but there is just one use case that it's not that uncommon: a search form which only has the |
@wouterj : I get what you mean, but I still there still is a problem with this § (so do you if, I interpret the "In progress" tag correctly). If you're not going to merge this change, then I think the first sentence should read : - Notice that you select
+ Notice that you actually select But then, if you consider notes as things that should not be read on a first,
They will think :
I think the documentation should be readable without the notes, and the notes should be here @javiereguiluz : In your case, the submission will be done with javascript, I guess ? |
@greg0ire I've tagged with in "In progress", since I'm not the only guy who decides what's going in the docs and what's not. I've read the section now and I think we should make a very minor change: - Just like links, you select forms with the ``selectButton()`` method::
+ Just like links, you select forms using the ``selectButton()`` method:: What do you think? If you agree, can you please update this PR? |
I think this shows the problem even more : this can me elaborated into
Maybe we would be better off with something like this :
A bit more lengthy, but also less confusing, I think. The main problem I'm trying to avoid here is having the reader think wrong, then read the note (we hope), unlearn what he just learnt, then think right. He should think right but wonder how he can select forms, then read the note, then think right. To avoid wrong thinking, the documentation must be clear from the start. |
I like it, can you please update your PR with your latest proposal? |
The note explains that we are selecting form buttons, not forms. Confusion ensues if we say otherwise in the introductory sentence.
@wouterj : glad you like it, I just updated the PR |
I really like what you ended up with. Thanks Grégoire! |
This PR was merged into the 2.3 branch. Discussion ---------- ensure consistency with the note The note explains that we are selecting form buttons, not forms. Confusion ensues if we say otherwise in the introductory sentence. Commits ------- 8a649a6 ensure consistency with the note
The note explains that we are selecting form buttons, not forms.
Confusion ensues if we say otherwise in the introductory sentence.