* @param type $setting
 * @return type

What is 'type'? What does this function expect, and what does it return?

CommentFileSizeAuthor
#8 eu_cookie_compliance-confusing-param-and-return-documentation-1594602-8.patch838 bytessvenryen
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Miszel’s picture

Miszel CreditAttribution: Miszel commented
Priority: Normal » Minor

The function returns either all popup settings for the current language or a single setting. So if you want to find out, for example, if the popup has been enabled, you could call it this way: eu_cookie_compliance_get_settings('popup_enabled').

I agree that the code documentation could be improved but with the approaching deadline, it is not my first priority.

Changed to minor as it does not affect the functionality.

rsvelko’s picture

rsvelko CreditAttribution: rsvelko commented
Category: bug » task

docs bugs better be considered tasks, not bugs ? imho... cause the module's image in the eyes of the non-techie users depends on how many open bugs a module has...

with bugs like this - its a waste of time to go and check on a bug that is not a bug and to +1 the number of bugs on the project page...

Miszel’s picture

Miszel CreditAttribution: Miszel commented

You are absolutely right. Cheers.

joachim’s picture

joachim CreditAttribution: joachim commented

Documentation bugs are definitely bugs in my opinion.

Miszel’s picture

Miszel CreditAttribution: Miszel commented
Status: Active » Closed (fixed)

fixed in 6.x-1.4 Thanks for reporting.

achton’s picture

achton
Location Denmark
CreditAttribution: achton commented
Status: Closed (fixed) » Active

Was this really fixed? I can't find the commit in question.

(Please link to the git commit on drupalcode.org when fixing, it really helps to review issues! :-))

  • svenryen committed d4c7f8a on 7.x-1.x 
    Issue #1594602: confusing param and return documentation for...
svenryen’s picture

svenryen CreditAttribution: svenryen at Ramsalt Lab commented
Issue summary: View changes
FileSize
eu_cookie_compliance-confusing-param-and-return-documentation-1594602-8.patch838 bytes

I realize this is a really old issue, but it was quite easy to fix, so here's a patch.

  • svenryen committed f1dd09c on 6.x-1.x 
    Issue #1594602 by svenryen: confusing param and return documentation for...
svenryen’s picture

svenryen CreditAttribution: svenryen at Ramsalt Lab commented
Status: Active » Fixed

  • svenryen committed d4c7f8a on 7.x-2.x 
    Issue #1594602: confusing param and return documentation for...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.