Problem/Motivation

Followup from #2851386: Rename behaviour to behavior in paragraphs_collection

+++ b/paragraphs_collection.api.php
@@ -11,9 +11,9 @@
  * Paragraphs Collection offers a plugin system which adds layout behavior to
  * various paragraph types.
  *
- * The module provides the following behaviour plugins:
+ * The module provides the following behavior plugins:
  *
- * @section behaviour Behaviour
+ * @section behavior Behavior

this documentation should be in paragraphs.module, collection doesn't offer it, it just uses it
There is an issue for moving this documentation in paragraphs.
#2857628: Move documentation for plugin system from collection to paragraphs module

Proposed resolution

Remove the documentation from paragraphs collection.

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#8 remove_documentation-2857630-8.patch639 bytesGinovski
#5 remove_documentation-2857630-5.patch661 bytesGinovski
#2 remove_documentation-2857630-2.patch991 bytesGinovski
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Ginovski created an issue. See original summary.

Ginovski’s picture

Ginovski CreditAttribution: Ginovski at MD Systems GmbH commented
Assigned: Unassigned » Ginovski
Priority: Normal » Minor
Status: Active » Needs review
FileSize
remove_documentation-2857630-2.patch991 bytes

Removed the documentation for the plugin system, changed the section to defgroup.

tduong’s picture

tduong CreditAttribution: tduong at MD Systems GmbH commented
Status: Needs review » Needs work 
  1. +++ b/paragraphs_collection.api.php
@@ -8,13 +8,13 @@
+ * Paragraphs Collection extends the paragraph types with various behavior

    I would add "... the paragraph types from Paragraphs module ..." 

  2. +++ b/paragraphs_collection.api.php
@@ -8,13 +8,13 @@
+ * @defgroup behavior Behavior

    According to the API documentation standards the @defgroup tag needs to be in its own docblock (not inside a file description docblock, function docblock, class docblock, etc.)., while @section tag is used to make section headings within a docblock.
    So let's keep it like before.

tduong’s picture

tduong CreditAttribution: tduong at MD Systems GmbH commented
Related issues: +#2857628: Move documentation for plugin system from collection to paragraphs module
Ginovski’s picture

Ginovski CreditAttribution: Ginovski at MD Systems GmbH commented
Status: Needs work » Needs review
FileSize
remove_documentation-2857630-5.patch661 bytes

Addressed #4 comment.

tduong’s picture

tduong CreditAttribution: tduong at MD Systems GmbH commented
Status: Needs review » Reviewed & tested by the community

Looks fine for me :)

Primsi’s picture

Primsi CreditAttribution: Primsi at MD Systems GmbH for MD Systems GmbH commented
Status: Reviewed & tested by the community » Needs work 
+++ b/paragraphs_collection.api.php
@@ -8,8 +8,9 @@
+ * Paragraphs Collection extends the paragraph types from Paragraphs module

It actually does not extend types from paragraphs it provides multiple paragraph types and behavior plugin implementations.

Ginovski’s picture

Ginovski CreditAttribution: Ginovski at MD Systems GmbH commented
Status: Needs work » Needs review
FileSize
remove_documentation-2857630-8.patch639 bytes

Changed docs accordingly.

  • Primsi committed 1d6674f on 8.x-1.x authored by Ginovski 
    Issue #2857630 by Ginovski, tduong: Remove documentation for the plugin...
Primsi’s picture

Primsi CreditAttribution: Primsi at MD Systems GmbH for MD Systems GmbH commented
Status: Needs review » Fixed

Committed, thanks.

Status: Fixed » Closed (fixed)

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