Download & Extend
Issues

Add missing type hinting to Syslog module docblocks

Posted by Lars Toomre on October 18, 2012 at 5:57pm
Project:Drupal core
Version:8.x-dev
Component:documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:closed (fixed)

Issue Summary

This is a sub-issue of #1800046: [META] Add missing type hinting to core docblocks focused on correctly adding @param and @return type hinting to the Syslog module.

Documentation patches that include type hinting are time consuming to both review and commit because one must dig into the actual code to confirm that the type hints are both correct and complete. Hence, please be patient and try to limit type hint patches to covering only a limited number of docblocks (20-25 as a guess).

Related sprint issues:

Sprint Topic Sub Issue
#1518116: [meta] Make Core pass Coder Review #1533392: Make syslog module pass Coder Review
#1310084: [meta] API documentation cleanup sprint #1368872: Clean up API docs for syslog
#500866: [META] remove t() from assert message #1797516: Remove t() from assertion messages in tests for the syslog module
Login or register to post comments

Comments

#1

Posted by bleen18 on October 20, 2012 at 3:54am
Status:active» needs review

It doesn't appear that there are any docblocks in the syslog module that need work. The attached patch fixes the smallest whitespace issue in the world.

AttachmentSizeStatusTest resultOperations
1816858.patch384 bytesIdlePASSED: [[SimpleTest]]: [MySQL] 42,808 pass(es).View details

#2

Posted by Lars Toomre on October 21, 2012 at 1:43am
Status:needs review» needs work

@bleen18 Thanks for this really small patch.

Looking at the code with the patch applied, I noticed that there is no explanation for the return statement in that same docblock. Could you add that here? I would be happy to RTBC after that is done.

The only other problem I saw with this module was an in-line comment in testSettings() at the end of the line. I do not think we should correct that problem here since this is a documentation patch. It does seem silly, though too, to create another small patch just to change the positioning of an inline comment to conform with our coding standards.

#3

Posted by bleen18 on October 21, 2012 at 2:08pm
Status:needs work» needs review
AttachmentSizeStatusTest resultOperations
1816858-03.patch495 bytesIdlePASSED: [[SimpleTest]]: [MySQL] 42,798 pass(es).View details

#4

Posted by Lars Toomre on October 21, 2012 at 9:52pm
Status:needs review» reviewed & tested by the community

Thanks @bleen18. This small little patch is RTBC!

After this is committed, there is nothing more that needs to be done for the Syslog module in D8.

#5

Posted by Lars Toomre on October 21, 2012 at 9:53pm
Component:syslog.module» documentation

Whoops... just to make sure @jhodgdon sees this, I am changing to documentation component.

#6

Posted by webchick on October 23, 2012 at 11:51pm
Assigned to:Anonymous» jhodgdon

Tum te tum...

#7

Posted by jhodgdon on October 26, 2012 at 3:42pm
Status:reviewed & tested by the community» fixed

Thanks! Committed to 8.x and 7.x.

#8

Posted by jhodgdon on October 26, 2012 at 4:02pm
Assigned to:jhodgdon» Anonymous

#9

Posted by System Message on November 9, 2012 at 4:10pm
Status:fixed» closed (fixed)

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

nobody click here