flood_is_allowed doc should be gender-neutral [#698978]

http://api.drupal.org/api/function/flood_is_allowed
Can we change the function description text to make it more gender neutral from:

Drupal 4.6, 4.7, 5

Check if the current visitor (hostname/IP) is allowed to proceed with the specified event. The user is allowed to proceed if he did not trigger the specified event more than $threshold times per hour.

to:

Check if the current visitor (hostname/IP) is allowed to proceed with the specified event. The user is allowed to proceed if they did not trigger the specified event more than $threshold times per hour.

Drupal 6

The user is allowed to proceed if he did not trigger the specified event more than $threshold times per hour.

to:

The user is allowed to proceed if they did not trigger the specified event more than $threshold times per hour.

Drupal 7

The user is allowed to proceed if he did not trigger the specified event more than $threshold times in the specified time window.

to:

The user is allowed to proceed if they did not trigger the specified event more than $threshold times in the specified time window.

thanks!

Comment	File	Size	Author
#2	698978.patch	1.79 KB	jhodgdon

Comments

Comment #1

jhodgdon

she/her

English

commented 8 February 2010 at 16:44

Title:	Documentation problem with flood_is_allowed	» flood_is_allowed doc should be gender-neutral
Version:	6.x-dev	» 7.x-dev

"they" is plural, so please do not replace "he" with "they", as it is grammatically incorrect.

Also, the patching should start with Drupal 7 and then go back to older versions.

Comment #2

jhodgdon

she/her

English

commented 8 February 2010 at 20:19

Status:

Active

» Needs review

Status	File	Size
new	698978.patch	1.79 KB

Here's a patch for D7 that fixes up the doc for this function, in the process making it gender neutral.

Comment #3

jbrown commented 8 February 2010 at 21:45

I think 'action' is better than 'event'.

Comment #4

jhodgdon

she/her

English

commented 8 February 2010 at 23:05

I was thinking about changing that too, but I left it as "event" since that is what it was before.

Also, the word "action" is used by actions.inc and trigger.module for something that is unrelated to what this function covers. I think maybe we need a word that is not "action" to avoid confusion.