Commit ae8a19d98bffd244fac1ce280e059c83a9366c46 did the following changes.

  • It removed the documentation comment containing the @defgroup tag
  • It removed the long description used for hook_file_download()
  • It created a README.md file with what the content of those documentation comments

Those changes are not correct because the content of those comments is the source for the documentation pages shown on https://api.drupal.org/api/examples, including that page which the front page for this project.

Those changes go in the opposite direction taken when it has been decided to include the Examples for Developers project on api.drupal.org.
Moving the content of those comments in a README.md file does not help developers for the same reason removing all the documentation comments from Drupal core and creating README.md files to replace those documentation comments would not help developers. api.drupal.org helps much in understanding how Drupal works, at the point the API module code has been rewritten for Drupal 10.

Those changes must be reverted.

Issue fork examples-3457813

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

apaderno created an issue. See original summary.

avpaderno’s picture

Issue summary: View changes

avpaderno’s picture

Status: Active » Needs review

I also removed two @see tags: one for a function that no longer exist starting from Drupal 8.x, and one for the routing file used by the module.

avpaderno’s picture

13 failing tests means the MR does not introduce failures in tests.

  • apaderno committed a67c16ce on 4.0.x
    Issue #3457813: Revert the changes done in commit ae8a19d9
avpaderno’s picture

Component: Other » File Example
Status: Needs review » Fixed

I was going to back port the changes to the 3.x branch, but the module's file has been almost all removed from that branch.

Status: Fixed » Closed (fixed)

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