Skip to content

Add doc. comments to methods? #43

@forevermatt

Description

@forevermatt

I really like this assertion library you've made (thanks!). However, it would be really nice if there were documenting comments (/** ... */) that my IDE could pick up as I'm using your library (for things like helping me figure out which parameter should be which for the contains(...) method).

For example, a helpful doc. comment for the contains(...) method might be...

/**
 * Assert that the given $value contains the given $subString.
 *
 * @param string $value The string to search (the haystack).
 * @param string $subString The string to search for (the needle).
 * @param string $message (Optional:) A custom error message if the
 *     assertion fails.
 */
public static function contains($value, $subString, $message = '')
{
    // ...
}

Have you considered adding those?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions