[policy] Remove the requirement for doxygen for test methods

Created on 10 October 2013, about 11 years ago
Updated 17 October 2024, 2 months ago

Problem/Motivation

It's an absolute waste of time and effort.

Proposed resolution

Update coding standards to say:

Every method MUST be documented, EXCEPT test case methods (e.g., MyTestClass::testFooBar()) when the method name itself sufficiently documents the method's purpose. If more information is needed to describe the the test case, a docblock should still be added. All other methods in test classes (helper methods, assertions, fixtures, etc.) still require documentation.

(proposal from #24)

Remaining tasks

User interface changes

📌 Task
Status

Needs work

Component

Documentation

Created by

🇨🇦Canada chx

Live updates comments and jobs are added and updated live.
  • DrupalWTF

    Worse Than Failure. Approximates the unpleasant remark made by Drupal developers when they first encounter a particular (mis)feature.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇬🇧United Kingdom catch

    @param and @return for new code or any test being updated are now covered by type hinting.

    This does not cover (sorry) @covers but I think we could allow only @covers in that case.

    Helper methods - if they're on an individual test, no docs for me. If they're on a base test class or trait, they should have docs anyway.

  • 🇳🇿New Zealand quietone

    added new issue summary template

Production build 0.71.5 2024