[wp-trac] [WordPress Trac] #61416: Improper DocBlock format for filter `pre_get_language_files_from_path` hook

WordPress Trac noreply at wordpress.org
Wed Jun 12 05:46:31 UTC 2024


#61416: Improper DocBlock format for filter `pre_get_language_files_from_path` hook
--------------------------+-----------------------------
 Reporter:  khokansardar  |      Owner:  (none)
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:  6.5
 Severity:  normal        |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 In changeset https://core.trac.wordpress.org/changeset/57287 for new
 filter named pre_get_language_files_from_path in WP_Textdomain_Registry
 hook docblock has misalignment `@params` and ended with `**/`.

 {{{
                  *
                  * @since 6.5.0
                  *
                  * @param null|array $files List of translation files.
 Default null.
                  * @param string $path The path from which translation
 files are being fetched.
                  **/
 }}}


 DocBlock structure should follow same consistency with wordpress
 standards. Its should be as below -

 {{{
                  *
                  * @since 6.5.0
                  *
                  * @param null|array $files List of translation files.
 Default null.
                  * @param string     $path  The path from which
 translation files are being fetched.
                  */
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/61416>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list