Problem/Motivation

Currently, file.info.yml says this:
description: 'Defines a file field type.'

In D8, it does an awful lot more than that. ;) It's also providing:

  • The File entity.
  • The managed_file form element.
  • File usage tracking.
  • The REST file upload resource.
  • ...

I doubt most site builders care about most of this, but I'm sure some of them would care about some of it. ;)

Proposed resolution

Update the file.info.yml description.

Remaining tasks

  1. Figure out what subset of what file.module does that most site builders looking at the .info.yml file or /admin/modules would care about.
  2. #include bikeshed.h
  3. Write the patch
  4. RTBC
  5. Commit

User interface changes

More accurate description of the file module on the /admin/modules page.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#20 3033185-20.patch425 bytesayushmishra206
#16 3033185-16.patch433 bytesayushmishra206
#11 3033185-7.patch425 bytesmitthukumawat
#6 info-file-description-3033185-6.patch420 bytesdinesh_kesarkar
#2 3033185-2.patch366 bytesmegha_kundar

Comments

dww created an issue. See original summary.

megha_kundar’s picture

megha_kundar commented
Status: Active » Needs review
StatusFileSize
new 3033185-2.patch366 bytes

Modified description field of the info file

dww’s picture

dww
we/he/they
commented
Status: Needs review » Needs work

@Megha_kundar: Thanks for the patch. However, I don't think we need to submit patches, yet. Each one churns the test bots for an hour. What we first need is to agree on the wording. We're still at step 1 in the remaining tasks, you jumped immediately to step 3. ;)

Regardless, I don't think "Defines file features." is an improvement. That's even more vague and still doesn't actually say what the module does.

How about this?

"Defines a file field type and provides features for storing and managing files on the site."

? Still don't think that's right, but it seems closer.

I also notice that it lives in the "Field types" group of modules. Insofar as it's providing a file field, that makes sense. But maybe it should be moved to the 'Core' section if we're expanding this to include more info than just the file field?

Anyway, let's please keep discussing via comments, not patches.

Thanks,
-Derek

dhirendra.mishra’s picture

dhirendra.mishra commented

How about "'Manages the creation of entity and form element, file usage tracking and REST file upload resource."

@dww, pls suggest if it make sense.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

dinesh_kesarkar’s picture

dinesh_kesarkar commented
StatusFileSize
new info-file-description-3033185-6.patch420 bytes

As per my understanding, whatever we implement in .module file that should be the description of a module. We must add same description what added at the beginning of file.module file.

Attaching patch.

Thanks, Dinesh

dinesh_kesarkar’s picture

dinesh_kesarkar commented
Status: Needs work » Needs review

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

mitthukumawat’s picture

mitthukumawat commented
StatusFileSize
new 3033185-7.patch425 bytes

Adding patch for 9.2.x-dev. The updated description is Defines a "managed_file" Form API field and a "file" field for Field module.

pragati_kanade’s picture

pragati_kanade commented
Status: Needs review » Reviewed & tested by the community

This looks good to me.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work

Needs a reroll.

andypost’s picture

andypost
he/him
Primary language Russian
commented

Form API field

I think the "field" here should be replaced with "element" as form API is not about fields

ayushmishra206’s picture

ayushmishra206 commented
Status: Needs work » Needs review
StatusFileSize
new 3033185-16.patch433 bytes

Made the change suggested in #15 and rerolled the patch for 9.2.x, Please review.

quietone’s picture

quietone commented

Should the work here move to #3060616: Update the module descriptions on the Extend page to fit the Help texts?

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3060616: Update the module descriptions on the Extend page to fit the Help texts
andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs review » Needs work
Parent issue: » #3060616: Update the module descriptions on the Extend page to fit the Help texts
Related issues: -#3060616: Update the module descriptions on the Extend page to fit the Help texts

"file" element for Field module

element here is weird and field already mentioned

ayushmishra206’s picture

ayushmishra206 commented
StatusFileSize
new 3033185-20.patch425 bytes

Updated the patch.

quietone’s picture

quietone commented
Status: Needs work » Closed (duplicate)

I looked at the #3060616: Update the module descriptions on the Extend page to fit the Help texts and found that Neslee Canil Pinto has moved the work here into that issue. Therefor closing this as a duplicate.