[wp-trac] [WordPress Trac] #35417: Audit "blog" usage in inline docs

[WordPress Trac]

#35417: Audit "blog" usage in inline docs
----------------------------------------+------------------------------
 Reporter:  ericlewis                   |       Owner:
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  4.5
Component:  Networks and Sites          |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:  docs, multisite
----------------------------------------+------------------------------

Comment (by mrahmadawais):

 Replying to [comment:10 ericlewis]:
 > [https://core.trac.wordpress.org/ticket/35417?cnum_edit=10#comment:9
 Replying to @mrahmadawais]:
 >
 > > most of the inline docs are about defining a particular argument that
 also contains a blog related name.
 >
 > In this case, I think it would be useful to change the description for
 `$blog_title` to `The new site title`, so that the misleading naming is
 within variable naming, not the documentation.
 >
 > I would suggest doing a regular expression search on all php files in
 the codebase like this: `\*.*[^\$]blog`. This will give you any lines that
 are inline documentation with the word blog. It will avoid places where
 `$` is prepended to `blog`, avoid false-positives for variable names that
 aren't of interest to us.


 Thanks for that. Makes sense.


 > Now it looks like there are about 587 matches. I think your previous
 thought regarding new tickets for new files would be a good idea at this
 point, that's a lot of fixes to make!
 >
 > I've created #35589 as a break-out ticket to focus on the file `wp-
 includes/link-template.php`. Would you like to try that? :D

 Yes, that's what I was talking about. Let's try that way.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/35417#comment:11>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform