Skip to content

Clarification of all-caps arguments #180

Description

@paulihl

I just tried to use SCAN and it kept throwing me some syntax errors until I found #64 with some googling and that showed me how to use it. As far as I can tell, there's nothing in the documentation that explains the documentation or calling conventions. Incidentally I don't see #167's modifications on metacpan.

$r->scan(cursor, [MATCH pattern], [COUNT count])

This pseudocode syntax means $r->scan(0, 'foo:*', 100) to me, and not $r->scan(0, MATCH => 'foo:*', COUNT => 100). Maybe it's obvious to others.

I'm not fully sure what's the best way to solve it, make a mention in "IMPORTANT NOTES ON METHODS" of the all-caps keywords being hash keys, add fatarrows in the pseudocode? Both?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions