Skip to:
Content

bbPress.org

Opened 6 months ago

Closed 6 months ago

Last modified 5 months ago

#3641 closed enhancement (fixed)

Suggestion for Improving Function Comment in bbPress Core

Reported by: viralsampat's profile viralsampat Owned by: johnjamesjacoby's profile johnjamesjacoby
Milestone: 2.7 Priority: normal
Severity: normal Version:
Component: General Keywords:
Cc:

Description

Hello Team,

Today, while reviewing the bbPress core files, I noticed that the global $pagenow variable is being used within a function, but it hasn’t been mentioned in the function’s comment block.

I believe it would be helpful to include this in the function’s comment for better clarity and documentation. This small improvement can enhance code readability and assist future contributors.

Thanks,

Attachments (1)

3641.patch (1.1 KB) - added by viralsampat 6 months ago.
I have checked above mentioned issue and resolved it. Here, I have added my patch.

Download all attachments as: .zip

Change History (4)

@viralsampat
6 months ago

I have checked above mentioned issue and resolved it. Here, I have added my patch.

#1 @johnjamesjacoby
6 months ago

  • Owner set to johnjamesjacoby
  • Resolution set to fixed
  • Status changed from new to closed

In 7343:

Docs: add/improve PHPDoc for $pagenow global in some places.

Props viralsampat.

In trunk, for 2.7.

Fixes #3641.

#2 @johnjamesjacoby
6 months ago

  • Milestone changed from 2.6.15 to 2.7
  • Type changed from defect (bug) to enhancement

This ticket was mentioned in Slack in #meta by viralsampat. View the logs.


5 months ago

Note: See TracTickets for help on using tickets.