PHPLIB-1117: Remove @api annotation #1087
Conversation
| * @see \MongoDB\Collection::watch() | ||
| * @see https://mongodb.com/docs/manual/reference/method/db.watch/#mongodb-method-db.watch | ||
| * | ||
| * @psalm-type ResumeCallable = callable(array|object|null, bool): ChangeStreamIterator |
There was a problem hiding this comment.
CS fix: Incorrect order of annotations groups.
| /** | ||
| * All classes are public API by default, unless marked with @internal. | ||
| */ | ||
| $rectorConfig->ruleWithConfiguration(RemoveAnnotationRector::class, ['api']); |
There was a problem hiding this comment.
I don't think PHPLIB does this, but is there any harm of removing @api from method annotations as well?
There was a problem hiding this comment.
I'm aware this removed everything that was in PHPLIB. I was just asking if it made sense to add a rule to remove method block annotations as well. I assume not, but was asking more to get a better understanding of how these rules are used.
Presumably, there's no need for even this rule to exist going forward (running at again would be a NOP) -- so I might be misunderstanding the purpose of collecting these rules in the rector configuration.
There was a problem hiding this comment.
The purpose of leaving these rules in place in the configuration file is to impose them on new developments or pending branches. If, for example, a developer forgets or ignores that @api annotations are no longer used, this will be corrected automatically before the code review.
Fix PHPLIB-1117
All classes are public API by default, unless marked with
@internal.These classes had none of these 2 annotations
@apior@internaland are part of the public api to be consistent with other*Resultclasses.BulkWriteResultClientCollectionDatabaseDeleteResultInsertManyResultInsertOneResultUpdateResult