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/ReplytoComment.php

    r48115 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      * Draft post
     26     * Draft post.
    2727     *
    2828     * @var mixed
     
    4444
    4545    /**
    46      * Reply as a privilged user (administrator)
    47      * Expects test to pass
    48      *
    49      * @return void
     46     * Tests reply as a privileged user (administrator).
     47     *
     48     * Expects test to pass.
    5049     */
    5150    public function test_as_admin() {
     
    9190
    9291    /**
    93      * Reply as a non-privileged user (subscriber)
    94      * Expects test to fail
    95      *
    96      * @return void
     92     * Tests reply as a non-privileged user (subscriber).
     93     *
     94     * Expects test to fail.
    9795     */
    9896    public function test_as_subscriber() {
     
    121119
    122120    /**
    123      * Reply using a bad nonce
    124      * Expects test to fail
    125      *
    126      * @return void
     121     * Tests reply using a bad nonce.
     122     *
     123     * Expects test to fail.
    127124     */
    128125    public function test_bad_nonce() {
     
    151148
    152149    /**
    153      * Reply to an invalid post
    154      * Expects test to fail
    155      *
    156      * @return void
     150     * Tests reply to an invalid post.
     151     *
     152     * Expects test to fail.
    157153     */
    158154    public function test_invalid_post() {
     
    172168
    173169    /**
    174      * Reply to a draft post
    175      * Expects test to fail
    176      *
    177      * @return void
     170     * Tests reply to a draft post.
     171     *
     172     * Expects test to fail.
    178173     */
    179174    public function test_with_draft_post() {
     
    193188
    194189    /**
    195      * Reply to a post with a simulated database failure
    196      * Expects test to fail
     190     * Tests reply to a post with a simulated database failure.
     191     *
     192     * Expects test to fail.
    197193     *
    198194     * @global $wpdb
    199      * @return void
    200195     */
    201196    public function test_blocked_comment() {
     
    226221
    227222    /**
    228      * Block comments from being saved
     223     * Blocks comments from being saved.
    229224     *
    230225     * @param string $sql
     
    240235
    241236    /**
    242      * Raises WP_Error after Posted a new pre comment
     237     * Tests blocking a comment from being saved on 'pre_comment_approved'.
    243238     *
    244239     * @ticket 39730
    245      * @return void
    246240     */
    247241    public function test_pre_comments_approved() {
     
    264258
    265259    /**
    266      *  Block comments from being saved 'pre_comment_approved', by returning WP_Error
     260     * Blocks comments from being saved on 'pre_comment_approved', by returning WP_Error.
    267261     */
    268262    function _pre_comment_approved_filter( $approved, $commentdata ) {
Note: See TracChangeset for help on using the changeset viewer.