Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mglaman opened this issue Aug 24, 2022 · 1 comment
Open

Comments

@mglaman
Copy link

mglaman commented Aug 24, 2022

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
Copy link
Collaborator

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants