Changeset 53539

Timestamp:

06/20/2022 09:44:27 PM (3 years ago)

Author:

audrasjb

Message:

Docs: Use third-person singular verbs for function descriptions in the Feed API, as per docblock standards.

See #55646.

File:

• trunk/src/wp-includes/feed.php (modified) (29 diffs)

trunk/src/wp-includes/feed.php

@@ -12 +12 @@
 
 /**
- * RSS container for the bloginfo function.
+ * Retrieves RSS container for the bloginfo function.
  *
  * You can retrieve anything that you can using the get_bloginfo() function.
@@ -42 +42 @@
 
 /**
- * Display RSS container for the bloginfo function.
+ * Displays RSS container for the bloginfo function.
  *
  * You can retrieve anything that you can using the get_bloginfo() function.
@@ -69 +69 @@
 
 /**
- * Retrieve the default feed.
+ * Retrieves the default feed.
  *
  * The default feed is 'rss2', unless a plugin changes it through the
@@ -93 +93 @@
 
 /**
- * Retrieve the blog title for the feed title.
+ * Retrieves the blog title for the feed title.
  *
  * @since 2.2.0
  * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
  *
- * @param string $deprecated Unused..
+ * @param string $deprecated Unused.
  * @return string The document title.
  */
@@ -120 +120 @@
 
 /**
- * Display the blog title for display of the feed title.
+ * Displays the blog title for display of the feed title.
  *
  * @since 2.2.0
@@ -148 +148 @@
 
 /**
- * Retrieve the current post title for the feed.
+ * Retrieves the current post title for the feed.
  *
  * @since 2.0.0
@@ -168 +168 @@
 
 /**
- * Display the post title in the feed.
+ * Displays the post title in the feed.
  *
  * @since 0.71
@@ -177 +177 @@
 
 /**
- * Retrieve the post content for feeds.
+ * Retrieves the post content for feeds.
  *
  * @since 2.9.0
@@ -208 +208 @@
 
 /**
- * Display the post content for feeds.
+ * Displays the post content for feeds.
  *
  * @since 2.9.0
@@ -219 +219 @@
 
 /**
- * Display the post excerpt for the feed.
+ * Displays the post excerpt for the feed.
  *
  * @since 0.71
@@ -236 +236 @@
 
 /**
- * Display the permalink to the post for use in feeds.
+ * Displays the permalink to the post for use in feeds.
  *
  * @since 2.3.0
@@ -252 +252 @@
 
 /**
- * Outputs the link to the comments for the current post in an xml safe way
+ * Outputs the link to the comments for the current post in an XML safe way.
  *
  * @since 3.0.0
@@ -269 +269 @@
 
 /**
- * Display the feed GUID for the current comment.
+ * Displays the feed GUID for the current comment.
  *
  * @since 2.5.0
@@ -280 +280 @@
 
 /**
- * Retrieve the feed GUID for the current comment.
+ * Retrieves the feed GUID for the current comment.
  *
  * @since 2.5.0
@@ -298 +298 @@
 
 /**
- * Display the link to the comments.
+ * Displays the link to the comments.
  *
  * @since 1.5.0
@@ -319 +319 @@
 
 /**
- * Retrieve the current comment author for use in the feeds.
+ * Retrieves the current comment author for use in the feeds.
  *
  * @since 2.0.0
  *
- * @return string Comment Author
+ * @return string Comment Author.
  */
 function get_comment_author_rss() {
@@ -339 +339 @@
 
 /**
- * Display the current comment author in the feed.
+ * Displays the current comment author in the feed.
  *
  * @since 1.0.0
@@ -348 +348 @@
 
 /**
- * Display the current comment content for use in the feeds.
+ * Displays the current comment content for use in the feeds.
  *
  * @since 1.0.0
@@ -366 +366 @@
 
 /**
- * Retrieve all of the post categories, formatted for use in feeds.
+ * Retrieves all of the post categories, formatted for use in feeds.
  *
  * All of the categories for the current post in the feed loop, will be
@@ -428 +428 @@
 
 /**
- * Display the post categories in the feed.
+ * Displays the post categories in the feed.
  *
  * @since 0.71
@@ -441 +441 @@
 
 /**
- * Display the HTML type based on the blog setting.
+ * Displays the HTML type based on the blog setting.
  *
  * The two possible values are either 'xhtml' or 'html'.
@@ -458 +458 @@
 
 /**
- * Display the rss enclosure for the current post.
+ * Displays the rss enclosure for the current post.
  *
  * Uses the global $post to check whether the post requires a password and if
@@ -499 +499 @@
 
 /**
- * Display the atom enclosure for the current post.
+ * Displays the atom enclosure for the current post.
  *
  * Uses the global $post to check whether the post requires a password and if
@@ -564 +564 @@
 
 /**
- * Determine the type of a string of data with the data formatted.
+ * Determines the type of a string of data with the data formatted.
  *
  * Tell whether the type is text, HTML, or XHTML, per RFC 4287 section 3.1.
@@ -577 +577 @@
  * @since 2.5.0
  *
- * @param string $data Input string
+ * @param string $data Input string.
  * @return array array(type, value)
  */
@@ -664 +664 @@
 
 /**
- * Display the link for the currently displayed feed in a XSS safe way.
+ * Displays the link for the currently displayed feed in a XSS safe way.
  *
  * Generate a correct link for the atom:self element.
@@ -685 +685 @@
 
 /**
- * Get the UTC time of the most recently modified post from WP_Query.
+ * Gets the UTC time of the most recently modified post from WP_Query.
  *
  * If viewing a comment feed, the time of the most recently modified
@@ -743 +743 @@
 
 /**
- * Return the content type for specified feed type.
+ * Returns the content type for specified feed type.
  *
  * @since 2.8.0
@@ -776 +776 @@
 
 /**
- * Build SimplePie object based on RSS or Atom feed from URL.
+ * Builds SimplePie object based on RSS or Atom feed from URL.
  *
  * @since 2.8.0