https://www.drupal.org/docs/develop/standards/api-documentation-and-comm... → doesn't say whether a @deprecated tag should or may include a link to a change record on drupal.org.
This means that most of core seems to link to the CR in a separate @see. The problem with doing this is that api.d.org shows that in the separate 'See also' section, and it's not clear to the reader that this URL is more information specifically about the deprecation.
See for example https://api.drupal.org/api/drupal/core%21includes%21database.inc/functio...
Docs standards should additionally say that a CR should be linked to if one exists, and that the link must be given within the @deprecated tag.
See for example https://api.drupal.org/api/drupal/core%21modules%21migrate_drupal%21src%...
State what you believe is wrong or missing from the current standards.
If we adopted this change, the Drupal Project would benefit by ...
Provide all proposed changes to the Drupal Coding standards → . Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:
The
@deprecatedtag is placed in a documentation block to indicate that a function, method, or class has been deprecated and should not be used, but has not yet been removed.Syntax
@deprecated in %deprecation-version% and is removed from %removal-version%. %extra-info%. @see %cr-link%Syntax notes
Add proposed text in blockquotes
For a full explanation of these steps see the Coding Standards project page →
Active
Coding Standards
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.