API page: https://api.drupal.org/api/drupal/core%21includes%21bootstrap.inc/functi...

This needs a @return to specify that it returns a timezone name.

CommentFileSizeAuthor
#10 2914834-10.patch1.74 KBsnehi
#10 interdiff.txt1.43 KBsnehi
#2 core-missing_return_for_drupal_get_user_timezone-2914834-2.patch500 bytestresti88

Comments

joachim created an issue. See original summary.

tresti88’s picture

tresti88
Primary language English
Location Manchester
commented
StatusFileSize
new core-missing_return_for_drupal_get_user_timezone-2914834-2.patch500 bytes

Hi

See attached patch, hope it's ok.

Thanks

tresti88’s picture

tresti88
Primary language English
Location Manchester
commented
Status: Active » Needs review
dinesh18’s picture

dinesh18 commented

I looked into the API mentioned above. I also tried to compare the structure with the other APIs.
I checked some API under "https://api.drupal.org/api/drupal/core%21includes%21bootstrap.inc/8.5.x" but none of them is having @return.
I don't think so we require @return. It is as per designed.

adriancid’s picture

adriancid
Primary language Spanish
Location Qc, Canada 🇨🇦
commented
Status: Needs review » Needs work

Maybe this is related to #2571965: [meta] Fix PHP coding standards in core, stage 1

I think that we should search to see is there is an issue more general or change the scope here to fix all the coding standards problems in the namespace or in the file.

joachim’s picture

joachim commented

#2571965: [meta] Fix PHP coding standards in core, stage 1 appears to be more about coding standards rather than docs -- though there might be a similar issue for docs.

> I think that we should search to see is there is an issue more general or change the scope here to fix all the coding standards problems in the namespace or in the file.

Yup, good idea. Though bigger patches take longer to do and are harder to get reviewed and committed.

adriancid’s picture

adriancid
Primary language Spanish
Location Qc, Canada 🇨🇦
commented

@joachim maybe we can fix at least all the @return in the file, if you want you can do the patch and I can reviewed or vice versa.

ivan berezhnov’s picture

ivan berezhnov commented
Issue tags: +CSKyiv18
andypost’s picture

andypost
he/him
Primary language Russian
commented
Parent issue: » #2571965: [meta] Fix PHP coding standards in core, stage 1
snehi’s picture

snehi commented
Status: Needs work » Needs review
StatusFileSize
new interdiff.txt1.43 KB
new 2914834-10.patch1.74 KB

Please review.

dev.patrick’s picture

dev.patrick commented
Status: Needs review » Reviewed & tested by the community

Patch applies cleanly, marking RTBC.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

  • catch committed 99b7c9f on 8.6.x 
    Issue #2914834 by snehi, tresti88, joachim: missing @return for...

  • catch committed bd02cff on 8.5.x 
    Issue #2914834 by snehi, tresti88, joachim: missing @return for...
catch’s picture

catch
he/him
Primary language English
commented
Version: 8.6.x-dev » 8.5.x-dev
Status: Reviewed & tested by the community » Fixed

Not entirely sure about the scoping here, but since the original reported issue can't be automated I don't think it makes sense to do this as if it was a coding standards issue. Committed/pushed to 8.6.x and cherry-picked to 8.5.x. Thanks!

Status: Fixed » Closed (fixed)

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