docs: Document the DataTable and DocString step argument types - #231
Merged
Conversation
stof
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the
DataTableandDocStringstep argument types added in Behat/Behat#1864, which @acoulton asked for as a follow-up.The two sidebars of "Multiline step arguments" now show the new types, since they are what a reader should reach for:
For tables the accessors are worth listing, because which one to use depends on the shape of the table and that is not obvious from the type name:
asMaps()for a table with a header row,asLists()for one without,asMap()for the two-column case, thencell(),row(),column(),height(),width(),isEmpty()andtranspose().Both sidebars say plainly that
TableNodeandPyStringNodestill work and are not deprecated, so nobody reads this as a migration they have to do.Two things I checked rather than assumed: the version is 3.33, since 3.32.0 is the latest release and the feature is merged on
3.x; and I dropped two:ref:links I had first written to aTableNodeand aPyStringNodesection, because no such anchors exist and they would have broken the build. The class names are written out instead.Built locally with
docker compose run --rm read-the-docs-builder build: build succeeded, and the rendered page carries the new sections.The snippet generation half of the follow-up is Behat/Behat#1878.