WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
06/30/2020 12:41:30 AM (4 years ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for Ajax comment tests per the documentation standards.

See #49572.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/tests/phpunit/tests/ajax/GetComments.php

    r47198 r48220  
    1717
    1818    /**
    19      * A post with at least one comment
     19     * A post with at least one comment.
    2020     *
    2121     * @var mixed
    … …  
    2424
    2525    /**
    26      * A post with no comments
     26     * A post with no comments.
    2727     *
    2828     * @var mixed
    … …  
    3939
    4040    /**
    41      * Get comments as a privilged user (administrator)
    42      * Expects test to pass
     41     * Gets comments as a privileged user (administrator).
    4342     *
    44      * @return void
     43     * Expects test to pass.
    4544     */
    4645    public function test_as_admin() {
    … …  
    7776
    7877    /**
    79      * Get comments as a non-privileged user (subscriber)
    80      * Expects test to fail
     78     * Gets comments as a non-privileged user (subscriber).
    8179     *
    82      * @return void
     80     * Expects test to fail.
    8381     */
    8482    public function test_as_subscriber() {
    … …  
    9896
    9997    /**
    100      * Get comments with a bad nonce
    101      * Expects test to fail
     98     * Gets comments with a bad nonce.
    10299     *
    103      * @return void
     100     * Expects test to fail.
    104101     */
    105102    public function test_bad_nonce() {
    … …  
    119116
    120117    /**
    121      * Get comments for an invalid post
    122      * Bad post IDs are set to 0, this should return valid XML
     118     * Gets comments for an invalid post.
    123119     *
    124      * @return void
     120     * Bad post IDs are set to 0, this should return valid XML.
    125121     */
    126122    public function test_invalid_post() {
    … …  
    140136
    141137    /**
    142      * Get comments for an invalid post
    143      * Bad post IDs are set to 0, this should return valid XML
    144      *
    145      * @return void
     138     * Gets comments for a post with no comments.
    146139     */
    147140    public function test_post_with_no_comments() {
Note: See TracChangeset for help on using the changeset viewer.