Update core.api.php Annotation documentation.

Created on 23 September 2024, 9 months ago

Problem/Motivation

The examples for the Annotation system in core/core.api.php should likely be updated now that the annotation system is close to being deprecated and core is almost done converting all Annotations to Attributes.

This was raised in πŸ“Œ Convert entity type discovery to PHP attributes Active

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component

plugin system

Created by

πŸ‡ΊπŸ‡ΈUnited States nicxvan

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @nicxvan
  • πŸ‡ΊπŸ‡ΈUnited States nicxvan
  • πŸ‡³πŸ‡ΏNew Zealand quietone
  • πŸ‡ΊπŸ‡ΈUnited States nicxvan
  • Merge request !11230make a start β†’ (Open) created by quietone
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    This tries to use replace the use of annotation style in the text and examples with attributes, except for leaving the 'annotations defgroup'. Some parts of the annotations defgroup is copied over to the Plugin API @defgroup and changed as needed to use attributes.

    There are still references to annotations that should change.

    Is this moving in the right direction?

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Not sure how to judge what should remain and what needs to be converted.

  • πŸ‡¨πŸ‡­Switzerland berdir Switzerland

    I would probably remove the annotation chapter. Or replace it completely with 1-2 sentences that just say that annotation based discovery is deprecated and point to the attribute docs in the plugin component?

  • πŸ‡¨πŸ‡­Switzerland berdir Switzerland

    Also, the entity type example shouldn't use content_type. The UI refers to node types as content types, so it should be new_entity_type or my_entity_type or something.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    #8. Added a sentence at the beginning that it will be deprecated and direct to the plugin section. Since we still need to support annotations I left the remainder of the chapter.

    #9: Fixed

    I also made more conversions from annotation to attribute in core.api.php and entity.api.php.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    I am not sure what the scope is here. The issue title does not match the issue summary. Ideas?

  • Pipeline finished with Success
    2 months ago
    Total: 596s
    #467980
  • The Needs Review Queue Bot β†’ tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

    This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

    Consult the Drupal Contributor Guide β†’ to find step-by-step guides for working with issues.

  • πŸ‡³πŸ‡ΏNew Zealand quietone
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    I made the scope 'all *.api.php' files.

  • Pipeline finished with Success
    about 2 months ago
    Total: 519s
    #469005
  • Status changed to Needs review 5 days ago
  • πŸ‡ΊπŸ‡ΈUnited States nicxvan

    I agree with the scope and excluding tests.

    I did a thorough review of the changes and had a bunch of suggestions.

    I have not yet pulled it down to search for missing changes. I used gitlab so line length may be wrong.

  • First commit to issue fork.
  • πŸ‡¦πŸ‡ΊAustralia larowlan πŸ‡¦πŸ‡ΊπŸ.au GMT+10

    One or two open threads on the MR

  • Pipeline finished with Failed
    2 days ago
    Total: 308s
    #515724
Production build 0.71.5 2024