Add Change Record to @deprecated for ResourcePluginManager.php getInstance().

CommentFileSizeAuthor
#11 add_change_record_to-2873761-11.patch660 bytessorabh.v6

Comments

ponies created an issue. See original summary.

ponies’s picture

Title: #2873742: Add Change record to @deprecated for ResourcePluginManager.php » Add Change record to @deprecated for ResourcePluginManager.php
ponies’s picture

Assigned: ponies » Unassigned
ponies’s picture

Title: Add Change record to @deprecated for ResourcePluginManager.php » Add Change record to @deprecated for ResourcePluginManager
wim leers’s picture

wim leers’s picture

Status: Active » Fixed

I personally think creating change records for trivial things like this is a waste of our time, but here it is: https://www.drupal.org/node/2874934.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

xjm’s picture

Status: Closed (fixed) » Active

The goal of these issues is not to add change record nodes, but to update the codebase documentation to link (hopefully existing) change records that explain how to convert from old APIs to new ones. So this issue is not completed yet, but we should figure out if the CR is correct or if a bigger, wider scope one that is more useful already exists.

wim leers’s picture

#8: That was not clear to me when I read this in #5/#6, but now it is. Thanks for reopening!

sorabh.v6’s picture

Assigned: Unassigned » sorabh.v6
sorabh.v6’s picture

StatusFileSize
new660 bytes

Linked change record for @deprecated. Please review the patch.

sorabh.v6’s picture

Status: Active » Needs review
sorabh.v6’s picture

Assigned: sorabh.v6 » Unassigned
wim leers’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +API-First Initiative

Thanks!

  • xjm committed 62397e8 on 8.4.x
    Issue #2873761 by sorabh.v6, Wim Leers: Add Change record to @deprecated...

  • xjm committed d2d80ed on 8.3.x
    Issue #2873761 by sorabh.v6, Wim Leers: Add Change record to @deprecated...
xjm’s picture

Status: Reviewed & tested by the community » Fixed

Thanks @Wim Leers and @sorabh.v6. I updated the change record slightly to make the wording a little more neutral:
https://www.drupal.org/node/2874934/revisions/view/10465936/10527658

There is a slight coding standards error in the patch; there should be a blank line above the @see section. Checking for this standard will be added in #2842949: Fix Drupal.Commenting.DocComment.SpacingBeforeTags coding standard. Meanwhile, I fixed it on commit:

@@ -40,6 +40,7 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
    * @deprecated in Drupal 8.2.0.
    *   Use Drupal\rest\Plugin\Type\ResourcePluginManager::createInstance()
    *   instead.
+   *
    * @see https://www.drupal.org/node/2874934
    */
   public function getInstance(array $options){

Committed and pushed to 8.4.x and cherry-picked to 8.3.x. Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

kay_v’s picture

Removing parent issue per conversation with @xjm at Drupalcon Nashville Mentored Sprint prep. Her recommendation to do so was based on a few points that made sense to all of us in the discussion, namely:
- so many child issues makes this parent unwieldy
- search filters will allow people needing to refind closed children