Need to change in docs comment in xmlrpc.php

[hiren1094]

Hello,

Need to change below the comment for this "logIO()" function.

Need to change comment "logIO() - Writes logging info to a file." line and It should be "Writes logging info to a file - logIO()." Also, add a full stop in the last for this line "@param string $io Whether input or output"

As per phpcs coding standard.

[hiren1094]

Patch Added

[audrasjb]

Hello and thanks for the ticket,

Could you please quickly explain why "Writes logging info to a file - logIO()." would be better or more understandable than "logIO() - Writes logging info to a file."? Thanks!

[hiren1094]

Hello @audrasjb,

As per phpcs standard, Doc comment short description must start with a capital letter so that's why I have changed the sequence because we don't change function name in comment.

[audrasjb]

Replying to hiren1094:

As per phpcs standard, Doc comment short description must start with a capital letter so that's why I have changed the sequence because we don't change function name in comment.

I think this rule actually doesn't apply to PHP functions, proper nouns or other nouns that need to be written with a first lowercase letter.

[hiren1094]

@audrasjb

I think you are correct, but I have one suggestion: we need to remove function name in a comment and keep "Writes logging info to a file." text compared to other function comments.