Commit ae8a19d98bffd244fac1ce280e059c83a9366c46 did the following changes.
- It removed the documentation comment containing the
@defgrouptag - 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
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
Comment #2
avpadernoComment #4
avpadernoI 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.
Comment #5
avpaderno13 failing tests means the MR does not introduce failures in tests.
Comment #7
avpadernoI 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.