Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
hook_captcha() documentation is lacking proper documentation and the API file has incorrect naming, too.
Todo:
- Rename
captcha_api.txt
tocaptcha.api.php
- Add $captcha_sid argument to the documenation and explain what it does. Not only explain that it exists and is an optional argument. It is not clear what it is made for, how it works and how unique it is.
Comment | File | Size | Author |
---|---|---|---|
#10 | d7_document_all-2842669-10.patch | 14.28 KB | yogeshmpawar |
#10 | interdiff-2842669-7-10.txt | 524 bytes | yogeshmpawar |
#7 | d7_document_all-2842669-7.patch | 14.12 KB | yogeshmpawar |
#2 | document_all_arguments-2842669-2.patch | 13.98 KB | yogeshmpawar |
Comments
Comment #2
yogeshmpawarComment #3
yogeshmpawarComment #4
hass CreditAttribution: hass commentedComment #5
hass CreditAttribution: hass commentedWe use @param to explain parameters.
$captcha_sid is not documented.
Comment #6
hass CreditAttribution: hass commentedFor about 15 years we are not duplicating cases. Where has this rule changed? We use need backport tag and move the casebetween branches once committed. This was we prevent regressions.
Comment #7
yogeshmpawarUpdated patch as per your comment #5 & #6.
Comment #8
yogeshmpawarUpdated interdiff for both the patches
Comment #9
hass CreditAttribution: hass commentedWhat is captcha session ID for and how does it work and what do I need to do as developer when I use it and how should I use it or for what. Nothing answered here. This is not helpful.
Comment #10
yogeshmpawarThanks @hass for the help to improve captcha.api.php, updated the patch as per comment #9.