Problem/Motivation

Incorrect grammar for the description text for a file field when adding new content.

Proposed resolution

Change the sentence from "may be" to "will be"

Remaining tasks

Need to change the sentence description.

Original report by gaele

How's that for an issue title? ;-)

The file field has a toggle "Enable Description field". The description of this toggle says:
"The description field allows users to enter a description about the uploaded file."

If enabled, and a user uploads a file, a Description field appears. The description of this field says
"The description may be used as the label of the link to the file.".

I believe both should say:
"The description will be used as the label of the link to the file."

CommentFileSizeAuthor
#11 Screen Shot 2016-10-23 at 14.35.07.png67.97 KBalexpott
#9 interdiff-1196306-8-9.txt1.35 KBminakshiPh
#9 unclear_description_of-1196306-9.patch1.52 KBminakshiPh
#6 fix-issue-1196306-8.patch1.48 KBminakshiPh
Filedescription-user.png4.18 KBgaele
Filedescription-admin.png6.26 KBgaele

Comments

trgreen17’s picture

trgreen17 commented

Agreed... very misleading.

And while we're at it... how can I have a description for a file but still show the file name as the link to download the file? I've tried all kinds of options in the "rewrite the output of this field" section, but if there's any description at all for the file, it always shows up as the link to the file.

It's kinda bizarre, actually. Why would you ever have a "description" of a file be the link to the file? Why not just let us have a link to a file (using the file name as the link), with a description beside it?

I'm gonna break into the core code to try to fix this. I guess I need to look in "file.field.inc" but if anyone can tell me for sure, I would really appreciate it!

Thanks,
Tim

sbakshian’s picture

sbakshian commented
Version: 7.x-dev » 8.x-dev
Issue tags: +tcdrupal2012

I was able to confirm that the text needs to be changed in Drupal 8

sbakshian’s picture

sbakshian commented
Issue summary: View changes

Added Issue Summary.

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

gnuget’s picture

gnuget
Primary language Spanish
commented
Issue summary: View changes
Issue tags: +Novice
minakshiPh’s picture

minakshiPh commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new fix-issue-1196306-8.patch1.48 KB

Added the patch with fix.

Kindly review.
Thanks!

sushantpaste’s picture

sushantpaste
Primary language Marathi
Location Sawantwadi India
commented
Status: Needs review » Reviewed & tested by the community

Looks good. @minakshiPh You can use patch name suggestions in future.

alexpott’s picture

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

"May" implies there are situations when the description is not used. "Will" implies there are no situation when it will not be used. In order to commit this string change there should be evidence of that the "Will" situation is true.

minakshiPh’s picture

minakshiPh commented
Status: Needs work » Needs review
StatusFileSize
new unclear_description_of-1196306-9.patch1.52 KB
new interdiff-1196306-8-9.txt1.35 KB

Hi @sushantpaste & @alexpott,

Thanks for reviewing my patch!
Modified the patch as mentioned in #8.

Kindly review.
Thanks!

arunkumark’s picture

arunkumark
Location Coimbatore
commented
Status: Needs review » Reviewed & tested by the community

Patch is Seems like working fine.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Closed (won't fix)
StatusFileSize
new Screen Shot 2016-10-23 at 14.35.07.png67.97 KB

I need to clarify what I was trying to say in #8. I think the current description is correct - this does not mean it can't be improved or shortened but the current change here is making it incorrect. This is because the description may used as the link label if the field formatter is configured to use it. However it may be configured to not use it. To see what I'm talking about:

  1. Install standard profile
  2. Add a file field to the article content type and enable the description field.
  3. On the "manage display" tab you can choose several formatters that will not use the label as the link to the file

Given this I'm closing the issue as won't fix.

xjm’s picture

xjm
she/her
Primary language English
commented

I agree with #11; the current text is both accurate (as far as it goes) and grammatically correct.