Skip to:
Content

BuddyPress.org

Opened 6 years ago

Closed 3 years ago

#5022 closed defect (bug) (worksforme)

More Documentation

Reported by: ericlewis Owned by: tw2113
Milestone: Priority: normal
Severity: normal Version:
Component: Core Keywords:
Cc: tw2113@…

Description

There's a lot of BuddyPress functionality that is undocumented inline, and could benefit from added documentation.

Attachments (2)

5022.diff (2.3 KB) - added by ericlewis 6 years ago.
Add block descriptions for rebuild_activity_comment_tree, get_child_comments, and get_recorded_components
5022.bp-activity-classes.diff (5.4 KB) - added by ericlewis 6 years ago.
more thorough work of bp-activity-classes from 5022.diff.

Download all attachments as: .zip

Change History (66)

#1 @ericlewis
6 years ago

What would be the best way to approach this? One master ticket here?

#2 @boonebgorges
6 years ago

  • Milestone changed from Awaiting Review to Future Release

I think one master ticket is fine, but it would be best (imho) if patches themselves were broken up into chunks. Like maybe, don't include docs for more than one file in a single diff. That'll make sure that there are fewer problems applying cleanly, and it'll make things easier to review.

Putting in Future Release as I assume it'll be an ongoing project.

@ericlewis
6 years ago

Add block descriptions for rebuild_activity_comment_tree, get_child_comments, and get_recorded_components

@ericlewis
6 years ago

more thorough work of bp-activity-classes from 5022.diff.

#3 @boonebgorges
6 years ago

I'd also like to use this as a master ticket for improving existing docblocks, for better adherence to the WP standards described here http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/

#4 @boonebgorges
6 years ago

In 7390:

Inline doc improvements for bp-activity-actions.php

See #5022

#5 @boonebgorges
6 years ago

In 7391:

Inline doc improvements for bp-activity-admin.php

See #5022

#6 @boonebgorges
6 years ago

In 7393:

Additional documentation and docs standards adherence in bp-activity-classes.php

See #5022

Props ericlewis

#7 @boonebgorges
6 years ago

In 7395:

Inline doc improvements for bp-activity-akismet.php

See #5022

#8 @boonebgorges
6 years ago

In 7396:

Inline doc improvements for bp-activity-cache.php

See #5022

#9 @boonebgorges
6 years ago

In 7397:

Inline doc improvements in bp-activity-filters.php

See #5022

#10 @boonebgorges
6 years ago

In 7398:

Inline docs improvements in bp-activity-functions.php and -classes.php

See #5022

#11 @boonebgorges
6 years ago

In 7399:

Improve inline docs in bp-core-component.php.

See #5022

#12 @boonebgorges
6 years ago

In 7400:

Improve inline docs in bp-activity-loader.php

See #5022

#13 @boonebgorges
6 years ago

In 7401:

Improve inline docs in bp-activity-notifications.php

See #5022

#14 @boonebgorges
6 years ago

In 7403:

Fixes some incorrect documentation syntax

See #5022

#15 @boonebgorges
6 years ago

In 7404:

Improve inline docs for bp_core_fetch_avatar()

See #5022

#16 @boonebgorges
6 years ago

In 7405:

Improve inline docs in bp-activity-template.php.

See #5022

#17 @boonebgorges
6 years ago

In 7406:

Documentation whitespace improvement in bp-activity-functions.php

See #5022

#18 @boonebgorges
6 years ago

In 7407:

Inline docs improvements in Blogs component:

  • bp-blogs-actions.php
  • bp-blogs-activity.php
  • bp-blogs-buddybar.php
  • bp-blogs-cache.php
  • bp-blogs-classes.php

See #5022

#19 @boonebgorges
6 years ago

In 7409:

Improve inline docs in Blogs component.

See #5022.

#20 @boonebgorges
6 years ago

In 7428:

Whitespace improvements for bp_core_fetch_avatar() docblock

See #5022

#21 @boonebgorges
6 years ago

In 7429:

Improve inline docs in bp-blogs-template.php

See #5022

#22 @boonebgorges
6 years ago

In 7433:

Improve inline docs in bp-core. See #5022

#23 @boonebgorges
6 years ago

In 7434:

Improve inline docs in bp-core. See #5022

#24 @boonebgorges
6 years ago

In 7444:

Improve inline docs in bp-core. See #5022

#25 @boonebgorges
6 years ago

In 7445:

Improve inline docs in bp-core. See #5022

#26 @boonebgorges
6 years ago

In 7446:

Improve inline docs in bp-core. See #5022

#27 @boonebgorges
6 years ago

In 7449:

Improve inline docs in bp-core. See #5022

#28 @boonebgorges
6 years ago

In 7451:

Improve inline docs in bp-core. See #5022

#29 @boonebgorges
6 years ago

In 7452:

Improve inline docs in bp-core. See #5022

#30 @boonebgorges
6 years ago

In 7457:

Improve inline docs in bp-core. See #5022

#31 @boonebgorges
6 years ago

In 7468:

Improve inline docs in bp-forums. See #5022

#32 @boonebgorges
6 years ago

In 7472:

Improve inline docs in bp-activity-admin.php. See #5022

#33 @boonebgorges
6 years ago

In 7476:

Improve inline docs in bp-core-catchuri.php. See #5022

#34 @boonebgorges
6 years ago

In 7554:

Improve inline docs in bp-forums component. See #5022

#35 @boonebgorges
6 years ago

In 7556:

Improve inline docs in bp-friends. See #5022

#36 @boonebgorges
6 years ago

In 7558:

Improve inline docs in bp-friends component. See #5022

#37 @boonebgorges
6 years ago

In 7560:

Improve inline docs in bp-friends component. See #5022

#38 @boonebgorges
6 years ago

In 7561:

Improve inline docs in bp-groups component. See #5022

#39 @boonebgorges
6 years ago

In 7644:

Improve documentation in the Friends component. See #5022

#40 @boonebgorges
6 years ago

In 7645:

Improve documentation in the Groups component. See #5022

#41 @boonebgorges
6 years ago

In 7648:

Improve inline documentation in bp-groups. See #5022

#42 @boonebgorges
6 years ago

In 7760:

Improve inline docs in bp-loader.php. See #5022

#43 @boonebgorges
5 years ago

In 8318:

Improved documentation in Members component. See #5022

#44 @boonebgorges
5 years ago

In 8319:

Improve inline documentation in Members component. See #5022.

#45 @boonebgorges
5 years ago

In 8335:

Improved documentation in Members component. See #5022

#46 @boonebgorges
5 years ago

In 8479:

Improved inline documentation in bp-messages.

See #5022

#47 @boonebgorges
5 years ago

In 8481:

Improve inline documentation in bp-messages.

See #5022

#48 @boonebgorges
5 years ago

In 8482:

Improved inline documentation in the Messages component.

See #5022

#49 @boonebgorges
5 years ago

In 8530:

Improved formatting for docblocks in bp-activity-functions.php

See #5022

#50 @boonebgorges
5 years ago

In 8533:

Improved documentation for xprofile_insert_field()

See #5022

#51 @boonebgorges
5 years ago

In 9025:

Improve inline documentation for Notifications component.

See #5022

#52 @boonebgorges
5 years ago

In 9026:

Improved inline documentation in bp-groups

See #5022

#53 @boonebgorges
5 years ago

In 9027:

Improved inline documentation in bp-groups

See #5022

#54 @boonebgorges
5 years ago

In 9028:

Inline documentation improvements for part of bp-groups-template.php

It's a big file

See #5022

#55 @boonebgorges
5 years ago

In 9046:

Some improvements to inline documentation in bp-groups-template.php

See #5022

#56 @boonebgorges
5 years ago

In 9048:

Some improved documentation in bp-groups-template.php

See #5022

#57 @boonebgorges
5 years ago

In 9057:

Improved documentation in bp-groups-template.php

See #5022

This ticket was mentioned in IRC in #buddypress-dev by boonebgorges. View the logs.


5 years ago

#59 @tw2113
5 years ago

  • Cc tw2113@… added

#60 @tw2113
5 years ago

I'll take over this one from here. :)

This ticket was mentioned in Slack in #buddypress by boone. View the logs.


5 years ago

#62 @tw2113
4 years ago

  • Owner set to tw2113
  • Status changed from new to assigned

#63 @tw2113
4 years ago

In 10417:

Adds @since tags to the docblocks at the top of the files.

See #5022.

#64 @tw2113
3 years ago

  • Milestone Future Release deleted
  • Resolution set to worksforme
  • Status changed from assigned to closed

I think this one is well covered enough to mark as closed. Though since it doesn't have a specific release, marking as "worksforme"

Note: See TracTickets for help on using tickets.