Display notes for a module even if the module is set to always check for updates.

Assume a newer branch of a module requires a newer version of another module (in my case Views) that will not be installed, ever. Displaying the content of the Notes field allows this to be documented so that it will be easily ignored when viewing available updates.

CommentFileSizeAuthor
#6 update_advanced-always_display_notes-1613414-6.patch4.24 KBAohRveTPV
#2 update_advanced-always_display_notes-1613414-2.patch3.4 KBAohRveTPV
#1 update_advanced-always_display_notes-1613414-1.patch3.4 KBAohRveTPV
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

AohRveTPV’s picture

AohRveTPV CreditAttribution: AohRveTPV commented
Issue summary: View changes
Status: Active » Needs review
FileSize
update_advanced-always_display_notes-1613414-1.patch3.4 KB

Seems sensible to me. I usually use the notes to document why a particular update is ignored, but I see no reason it could not be used for other purposes.

Note that this patch violates two current coding standards for consistency with the existing code:
1. No documentation of parameter/return types.
2. No blank line between @param and @return comments.

AohRveTPV’s picture

AohRveTPV CreditAttribution: AohRveTPV commented
FileSize
update_advanced-always_display_notes-1613414-2.patch3.4 KB

Ignore previous patch.

AohRveTPV’s picture

AohRveTPV CreditAttribution: AohRveTPV commented

The function name update_advanced_get_project_admin_note() would maybe be more consistent with update_advanced_is_project_ignored() than update_advanced_get_admin_note(), which lacks the word project.

AohRveTPV’s picture

AohRveTPV CreditAttribution: AohRveTPV commented

Correction: Omitting data types in function comments is not a violation of coding standards as I said in #1. Data types are only required for D8.

AohRveTPV’s picture

AohRveTPV CreditAttribution: AohRveTPV commented
Status: Needs review » Needs work

README.txt needs to be updated accordingly.

AohRveTPV’s picture

AohRveTPV CreditAttribution: AohRveTPV commented
Status: Needs work » Needs review
FileSize
update_advanced-always_display_notes-1613414-6.patch4.24 KB

Updates #2 to clarify README.txt documentation of administrator note feature. With this change, administrator notes are not necessarily used to record the reason releases are ignored.

This README.txt change may not be necessary.