Skip to:
Content

BuddyPress.org

Opened 2 years ago

Closed 23 months ago

#8890 closed defect (bug) (fixed)

Docs: Improve various globals documentation, as per docblock standards.

Reported by: upadalavipul's profile upadalavipul Owned by: imath's profile imath
Milestone: 12.0.0 Priority: normal
Severity: normal Version:
Component: (not sure) Keywords: has-patch
Cc:

Description

Function commenting details needs to improve.

Files:

  • src/bp-xprofile/classes/class-bp-xprofile-group.php
  • src/bp-xprofile/classes/class-bp-xprofile-meta-query.php
  • src/bp-xprofile/classes/class-bp-xprofile-profiledata.php
  • src/bp-xprofile/classes/class-bp-xprofile-query.php

Attachments (22)

8890.patch (5.4 KB) - added by upadalavipul 2 years ago.
8890.2.patch (5.2 KB) - added by upadalavipul 2 years ago.
Few more files in improve various globals documentation.
8890.diff (3.8 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890.2.diff (3.8 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890.3.diff (6.4 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890-bp-blogs-activity.diff (1.8 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890-bp-blogs-functions.diff (1.3 KB) - added by viralsampat 2 years ago.
8890-bp-blogs-template.diff (1.8 KB) - added by viralsampat 2 years ago.
8890-bp-blogs-widgets.diff (439 bytes) - added by viralsampat 2 years ago.
8890-class-bp-blogs-blog.diff (6.3 KB) - added by viralsampat 2 years ago.
8890-class-bp-blogs-recent-posts-widget.diff (677 bytes) - added by viralsampat 2 years ago.
8890-bp-core-catchuri.diff (450 bytes) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890-bp-core-filters.diff (1.1 KB) - added by viralsampat 2 years ago.
8890-bp-core-options.diff (499 bytes) - added by viralsampat 2 years ago.
8890-bp-core-template-loader.diff (460 bytes) - added by viralsampat 2 years ago.
8890-bp-core-template.diff (653 bytes) - added by viralsampat 2 years ago.
8890-bp-core-update.diff (1.5 KB) - added by viralsampat 2 years ago.
8890.3.patch (13.1 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890.4.patch (6.1 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890.5.patch (623 bytes) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890.6.patch (2.1 KB) - added by viralsampat 2 years ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.
8890.7.patch (3.3 KB) - added by upadalavipul 23 months ago.
Few more files in improve various globals documentation.

Download all attachments as: .zip

Change History (37)

@upadalavipul
2 years ago

#1 @imath
2 years ago

  • Keywords has-patch commit added
  • Milestone changed from Awaiting Review to 12.0.0

Hi @upadalavipul

Thanks for your contribution, patch looks good 👍. I will commit it shortly.

#2 @imath
2 years ago

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

In 13475:

Improve inline doc, informing about $wpdb usage in functions

Props upadalavipul

Fixes #8890

@upadalavipul
2 years ago

Few more files in improve various globals documentation.

#3 @imath
2 years ago

  • Component changed from Core to Extended Profile
  • Keywords commit removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

#4 @imath
2 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 13484:

Improve inline doc, informing about global variable usage in functions

In various xProfile component files, used globals are:

  • $wpdb: the WordPress database object,
  • $profile_template: the xProfile data template object,
  • $group: the current group of profile fields in a loop,
  • $field: the current field in a loop.

Props upadalavipul

Fixes #8890

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

#5 @imath
2 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Hi @viralsampat

Thanks a lot for these 3 new patches. I'll review it asap.

#6 @imath
2 years ago

Hi @viralsampat

For your next contributions, could you use the --no-prefix option when saving your diffs. Thanks in advance 🙏.

I'll commit the inline doc improvements shortly.

#7 @imath
2 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 13491:

Improve inline doc, informing about global variable usage in functions

Props viralsampat

Fixes #8890

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

#8 @imath
2 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Hi thanks for the patch @viralsampat as I've requested in comment:6 using the --no-prefix option would have save us some more time, please consider using it for your next patches. By the way, you can include more than one file into your patches.

Last edited 2 years ago by imath (previous) (diff)

#9 @imath
2 years ago

  • Keywords needs-refresh added

Also, please use the BuddyPress trunk version to build your diffs, bp_core_set_uri_globals() is deprecated and is no more in src/bp-core/bp-core-catchuri.php meaning this patch is outdated.

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

#10 @imath
2 years ago

  • Keywords needs-refresh removed

Thanks for the refresh I will check the patch and commit changes asap.

#11 @imath
2 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 13496:

BP Groups: inform about global variable usage in functions docblocks

Props viralsampat

Fixes #8890

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

#12 @imath
2 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Hi @viralsampat Thanks a lot for this new patch. I will review & commit it asap.

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

@viralsampat
2 years ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

#13 @imath
2 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 13499:

Improve inline doc, informing about global variable usage in functions

These improvements are about various BP Members, BP Messages & BP Notifications files.

Props viralsampat

Fixes #8890

@upadalavipul
23 months ago

Few more files in improve various globals documentation.

#14 @imath
23 months ago

  • Component changed from Extended Profile to (not sure)
  • Resolution fixed deleted
  • Status changed from closed to reopened

#15 @imath
23 months ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 13517:

Inform about $activities_template usage in some functions inline doc

Props upadalavipul

Fixes #8890

Note: See TracTickets for help on using tickets.