search

acquia / coding-standards-php

PHP_CodeSniffer rules (sniffs) for Acquia coding standards
GNU General Public License v2.0
19 stars 13 forks source link

Do not apply Drupal.Commenting.Deprecated.DeprecatedWrongSeeUrlFormat #48

Open mglaman opened 2 years ago

mglaman commented 2 years ago

As a developer I would like to @see a non-Drupal link

Right now you cannot use @see to link to other documentation in regards to a change. This is also required if something is marked as @deprecated. I should be able to link to product documentation on another site.

danepowell commented 2 years ago

@mglaman this sounds like a bug in the Coder module. The DeprecatedWrongSeeUrlFormat warning is part of the DeprecatedSniff, which implies that it's only meant to apply to @see tags appearing adjacent to a deprecation tag. If you're seeing this warning outside of a deprecation, can you open an upstream bug with Coder?

This raises a somewhat thornier question: should we encourage projects that aren't Drupal modules to use Drupal coding standards? If Drupal decides that only documentation on drupal.org can be referenced by @see tags, is that a bug or a feature when applied to projects that aren't Drupal modules but want to follow the same coding standards?