Rewrite the chapter about traversing pages#50
Conversation
|
@aik099 I would appreciate a review on this one |
There was a problem hiding this comment.
- Maybe we should use table notation here or list or unordered list (ul/li) like it was done before:
*``id_or_name``- description. - The
idandid_or_nameselectors are only available since Mink 1.6
I guess we should mentioned version number, when particular feature was introduced and when it will be deprecated in the documentation, like it's done in Symfony docs.
There was a problem hiding this comment.
this is using a definition list in the output (<dl>). IMO, it looks much more readable than a table here.
Regarding version where it has been added, I agree for Mink 1.7+ features. However, I'm not sure it makes sense to add it for features which in Mink 1.6 (it has been released 5 months ago, and there was no uptodate doc for 1.4 or 1.5 at all). What do you think
There was a problem hiding this comment.
I guess many people still use Mink 1.5 and when they see in documentation the id_or_name, then it would be useful to know, that they should upgrade to Mink 1.6 to use it.
There was a problem hiding this comment.
Well, we have lots of changes between Mink 1.5 and 1.6 in the way function works (because they were not defined in a consistent way in Mink 1.5 because of the crappy driver tests). So making the doc highlight the changes from Mink 1.5 to 1.6 might make our job harder (and we are already missing lots of doc)
There was a problem hiding this comment.
I'm not talking about all documentation. Just where new functionality (not bugfixes) were introduced in 1.6 version we need to highlight that.
There was a problem hiding this comment.
The versionadded directive is not styled by the RTD theme currently. See readthedocs/sphinx_rtd_theme#99
So using it currently looks ugly.
There was a problem hiding this comment.
Wow. I wasn't aware, that there is a special directive for that. I was just thinking about something like some feature .... (since 1.5) text.
|
Today’s review completed. |
|
@aik099 updated |
|
OK, merging this as you haven't made other comments. |
Rewrite the chapter about traversing pages
Closes #36