AnnotatedClassDiscovery::getPluginNamespaces() description is inaccurate and unclear.

Think the proposed solution should be documented

But not sure this makes it clearer @joachim what do you think?

The first line is now too long. Fine details should go in the @return.

It's tricky though, because 'Gets an array of PSR-4 namespaces' is patently wrong -- when we say 'an array of FOO' we mean FOO are values, not keys. If we say 'Gets an array of directories' then it clashes with the method name getPluginNamespaces()!

So I would do this for the first line

> * Gets PSR-4 namespaces and directories to search for plugin classes.

We have to lose the 'array' to make the line fit.

And then proper details in the @return.

Create patch with suggestion in #6. Please review the patch.

Moving to NW for the issue summary update.

+use Doctrine\Common\Annotations\AnnotationRegistry;
 use Drupal\Component\Annotation\AnnotationInterface;
-use Drupal\Component\FileCache\FileCacheFactory;
-use Drupal\Component\Plugin\Discovery\DiscoveryInterface;
 use Drupal\Component\Annotation\Doctrine\SimpleAnnotationReader;
 use Drupal\Component\Annotation\Doctrine\StaticReflectionParser;
 use Drupal\Component\Annotation\Reflection\MockFileFinder;
-use Doctrine\Common\Annotations\AnnotationRegistry;
+use Drupal\Component\FileCache\FileCacheFactory;
+use Drupal\Component\Plugin\Discovery\DiscoveryInterface;
 use Drupal\Component\Plugin\Discovery\DiscoveryTrait;
 use Drupal\Component\Utility\Crypt;

Seems out of scope of the issue.

CC failure.

Tried to fix CCF in #14.

Thanks for improving the docs!

I'm triaging RTBC issues → . I read the IS and the comments. I didn't find any unanswered questions.

I then read the patch.

1. +++ b/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php
   @@ -180,9 +180,11 @@ protected function prepareAnnotationDefinition(AnnotationInterface $annotation,
   -   * Gets an array of PSR-4 namespaces to search for plugin classes.
   +   * Gets PSR-4 namespaces and directories to search for plugin classes.
   

   Adding the details of the associative array in the summary is not a pattern I've seen. And there are so many methods returning arrays where this would be impractical. This can simply be "Gets PSR-4 namespaces to search for plugin classes". Then the details can be in the @return description.

2. +++ b/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php
   @@ -180,9 +180,11 @@ protected function prepareAnnotationDefinition(AnnotationInterface $annotation,
   +   *   An array where keys are namespaces and
   +   *   values are directories for searching plugin classes.
   

   This should be wrapped to 80 columns.

   More common, is this format. "An associative array of directories keyed by namespace."

Setting to NW for the above.

Thanks @quietone, as you mentioned in your comment, I have made changes, please review it.

Believe points in #19 have been addressed.

@roshni27, thanks. the change for 19.1 reads better. However, for 19.2 the change did not consider the entire comment I made. It is fine if you disagree with the suggestion but it is good practice to explain you viewpoint. Even so, the text still needs to be wrapped correctly.

Setting back to NW.

We, the mentoring team, are triaging issues for first time contributors at DrupalCon Lille and I think this is a good issue for the contribution day.
We are reserving this issue so please don't work on this issue if you are not at DrupalCon Lille. You can continue the work when the event is over.

I am working on this issue at DrupalCon Lille.

Trying to launch a drupalpod on the issue, I get this error in screenshot.

Is this patch fixing the issue ?
I am still trying to find my way, I hope it helps.