Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Whenever something has been @deprecated we are supposed to tell people what to use instead.
Comment | File | Size | Author |
---|---|---|---|
#11 | correct_deprecated_doc_block-2867882-11.patch | 25.3 KB | Dinesh18 |
Comments
Comment #2
vegantriathletePatch attached!
Comment #3
vegantriathleteComment #4
vegantriathleteI am wondering if I should have put four "Use . . . instead" statements in the docBlock for the clearCachedDefinitions() method. I have put just the one that is not supposed to be removed as noted in the @todo.
@see: http://cgit.drupalcode.org/drupal/tree/core/lib/Drupal/Core/Entity/Entit...
Comment #5
BerdirPasted from IRC:
not sure, referencing them all would be the safe option, something like to clear cached entity types, use X, to clear cached entity bundle information, use X. to clear entity field definitions, use X. actually, the last can be left out, if anything then that's something that needs to happen automatically when caches are cleared, not a public api
also, the onX methods are event listeners, not an API that should be called directly, so IMHO, they don't really to have replacement information
Forget that, I think this is fine as it is.
The additional calls are all depending data on the entity type definitions and they should somehow listen to that cache clear and re-act to it and the previously public method have their own deprecated documentation.
Comment #6
joshmillerI just checked and the patch applies and appears to have the right format with a good reason to think it's good from Berdir.
Sounds like an RTBC.
Comment #7
Gábor HojtsyWe are in the process of adding @see links to these as well, so it would be appropriate to do it here I think instead of needing to change all of them again. The @see would be a URL to the change record where this change was made.
Comment #8
naveenvalechaHere's the CR link https://www.drupal.org/node/2549139
Comment #9
vegantriathleteComment #10
naveenvalechaThanks, @vegantriathlete for rerolling the patch. We're near to RTBC. only few nitpicks needs to be addressed
Add the @see statement after the Use and add a new line space b/w @see and Use. We need to change it across all places.
//Naveen
Comment #11
Dinesh18 CreditAttribution: Dinesh18 as a volunteer commentedHere is an updated patch which implements #10
Comment #12
naveenvalechaThanks, @Dinesh18! This is the first Quickfix of the month which I'm RTBCing
//Naveen
Comment #13
Gábor HojtsyComment #16
Gábor HojtsyThanks for the update, now this looks much more complete :)
Comment #18
Mile23Missed some: #2897015: EntityManager class/method @deprecation is incomplete
Also, this fix turns #2873798: Add Change record to @deprecated for EntityManager into a duplicate and really belongs under #2873705: Add change records to all @deprecated code