Closed (fixed)
Project:
Field collection
Version:
7.x-1.x-dev
Component:
Code
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
2 Jun 2016 at 06:24 UTC
Updated:
17 Feb 2021 at 21:19 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
harivenuvCoding standard corrected.
Worked file.
patch added.
Comment #3
harivenuvComment #4
jmuzz commentedThanks @harivenu_zyxware, it would be great to get this module up to date with coding standards.
A couple of things:
The parameters aren't all the correct type. For example some items are labelled as array's which aren't.
Function and class summary lines should start with the verb about what the thing does. Ex. "gets" or "fetches". See more details on this page.
Comment #5
harivenuvhi Jmuzz,
I will improve the coding standards quality based on your comment.
Comment #6
harivenuvhi,
Created a patch to double check the parameter type again and changed the function summery lines.
Comment #7
harivenuvComment #8
harivenuvTo the maintainers, would be really glad if you could review and merge patch @ #6 and make it available as its very common need.
Comment #9
chris matthews commentedThe 3 years old patch in #6 does not apply to the latest 7.x-1.x dev snapshot and is probably too old to reroll, but I went ahead and tagged the issue accordingly.
Comment #10
liam morlandNew patch attached.
Comment #11
renatog commentedThere are functions with doc block comment empty
Please, can you fix it? And we'll be able to commit it
Thanks a lot
Comment #12
liam morlandThe automated coding standards tools will add empty docblocks where they are missing. This clears some coding standards errors. This patch does not fix everything, manually filling-in the function documentation is still needed, but the patch is still an improvement and should be committed.
I'm not in a position to complete all that documentation because I don't know what those functions do.
Comment #13
renatog commentedAh okay, that makes sense.
I know the tool insert the docblock empty and a human needs to go there and fill it with a description
Thank you so much! This patch is very useful - but we need to fill these docblocks before commit
Comment #14
renatog commentedInserting a "novice" tag, if someone wants to help us
Comment #15
liam morlandIs it really novice? Completing the documentation requires understanding what the functions do.
I think it would be better to have empty docblocks than none at all. It is still a step towards compliance.
Comment #16
renatog commentedYeah, maybe is not so easy. I don't know if is so hard to read the code to understand, but ok I agree with you
It another point of view.
Okay, let's evaluate this. Really makes sense
Comment #18
renatog commentedMoved to the dev branch
Thank you so much