Use case

You updated the description of a custom field but the change is not shown on the expected issue screens. This is because the description text in field configuration (if present) overrides the original field description text. Having said that,

• If a custom field "My Field" is defined with a description of "This is my field" and no field configuration changes are made, then the displayed text will be "This is my field" as expected
• If field configurations are used and a description "This is my excellent field" is set for the custom field in the field description, then the displayed text will be "This is my excellent field"

Sometimes it requires some troubleshooting to figure out why the description change is not effective.

Suggestion

• Clarify in the documentation that the description text in field configuration takes precedence over the original field description text and hence, changes should be done on field configuration in some use cases
• Tooltip or any kind of help text to inform admins that the description text on the custom fields page will be overwritten by field configuration if present