[Console] Add documentation for QuestionHelper#3752
[Console] Add documentation for QuestionHelper#3752weaverryan merged 1 commit intosymfony:masterfrom
Conversation
There was a problem hiding this comment.
[...] instead, which is more [...]
|
Thank you for writing this! I've put some comments and although they are not caused by you (since you somewhat copied the original article), I would appreciate it if you can fix them. You also need to add this new document in the correct place in |
|
Sure ! it was indeed easier for me to port the dialog helper to question helper (as a matter of writing a brand new page). |
|
PR updated, comments addressed |
There was a problem hiding this comment.
maybe [...] is deprecated as of Symfony 2.5 [...], what do you think?
There was a problem hiding this comment.
We used "has been deprecated in Symfony 2.5" in another PR today
There was a problem hiding this comment.
In #3461 we use deprecated as of as the short form. So, for consisteny I would use is deprecated as of as the long form.
There was a problem hiding this comment.
let me know which consistency I should use :)
There was a problem hiding this comment.
the question here is whether we look at the state of the feature (the helper is deprecated) or at the action of marking it as deprecated (The developers have deprecated this feature in 2.5 which gives as the feature has been deprecated in 2.5).
I would vote in favor of is deprecated by looking at the current state of the feature
There was a problem hiding this comment.
I like any of the following
is deprecated as of Symfony 2.5
was deprecated in Symfony 2.5
The second sounds a bit more natural, only because of the "as of" in the first sounds "ok" to me, but I don't know if that's so easy to understand for non-native speakers (but I have no idea!). I guess this is also consistent with the "was introduced" we're using for new features. It makes it sound like the deprecation of addition of features happened at a point in time, which makes sense to me.
Another fun editorial conversation :) - I think they're all "correct", so now it's just a matter of taste.
This is the documentation for the new Question Helper