The Facets Summary processor plugin docblocks appear to have been copied from one to another and some didn't get changed (we all do this sometimes). 4/5 have the same class description, "Provides a processor that hides the facet when the facets were not rendered." It's a good novice issue if there's any contribution newbie who wants to tackle it. I'm happy to help provide guidance if someone wants to get their feet wet.

CommentFileSizeAuthor
#5 2913376.patch6.12 KBborisson_
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

dcam created an issue. See original summary.

sukh.singh’s picture

Hi @dcam, I would like to make a contribution. Please provide guidance, how should I proceed with it?

dcam’s picture

Sorry I haven't responded before now, but I haven't had much time to do contribution work this week. I'm working long hours because I have two projects wrapping up soon. Consequently, I can't stop to give specific instructions right now, but I can point you to some resources for helping new contributors get started.

Contributor task: Create a patch for a Drupal core issue - This says it's for Core Drupal, but you don't need to worry about that. There's still good info in there. Specifically, you need to have Git set up in order to download the module and to create the patch. Since you're only editing documentation text and not fixing a bug you don't need to have a webserver set up or do any testing.

Novice code contribution guide - This is probably going to have the most useful information for you about the patch workflow we use and how to create one.

Contribute to development - This looks like it has general info for people who want to contribute to development.

Basically, you want to clone the Facets module with Git (hopefully one of those pages will tell you how), edit the files I mentioned following our Documentation Standards, use Git to create the patch, then upload it to a new comment here.

If you have any problems, then reply and I'll try to provide you with more guidance.

borisson_’s picture

As a more specific point to help. What actually needs to happen is go all the files in modules/facets/modules/facets_summary/src/Plugin/facets_summary/processor and check their docblocks.

/**
 * Provides a processor that hides the facet when the facets were not rendered.
 *
 * @SummaryProcessor(
 *   id = "show_summary",
 *   label = @Translation("Show a summary of all selected facets"),
 *   description = @Translation("When checked, this facet will show an imploded list of all selected facets."),
 *   stages = {
 *     "build" = 50
 *   }
 * )
 */

It's the first line in that docblock, as well as the label and description that need to be checked an make sure that they correctly describe what the actual processor does. From a brief glance, the label seems to be correct for most of the processors so that's a solid starting point to see what the others should say.

borisson_’s picture

Status: Active » Needs review
FileSize
6.12 KB

Fixed the documentation, also rewrote some code to be easier to read (by removing nesting).

  • borisson_ committed aca9c6a on 8.x-1.x
    Issue #2913376 by borisson_: Facets Summary processor plugin docblocks...
borisson_’s picture

Status: Needs review » Fixed

Committed and pushed.

Status: Fixed » Closed (fixed)

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