hook_update_N documentation has two dead links on Drupal.org:

This patch replaces them with the link with information needed.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

Status: Needs review » Needs work
Issue tags: +Needs backport to D7

Good catch, thanks!

I think we should also remove the link to http://drupal.org/documentation/version-info -- it doesn't seem at all relevant. The Git page you referenced has all the necessary information I think?

And maybe if this is the only information we're including about releases and numbers, that link should be moved up to the paragraph that currently says:

A good rule of thumb is to remove updates older than two major releases of Drupal. See hook_update_last_removed() to notify Drupal about the removals.

kotnik’s picture

Yes you're quite right, http://drupal.org/documentation/version-info does not give useful information. I think that Git page does.

I'll send updated patch.

kotnik’s picture

Status: Needs work » Needs review
FileSize
1.76 KB

Here's re-roll that removes all obsolete links, and moves paragraph up as you've suggested.

sven.lauer’s picture

Status: Needs review » Needs work

I think what @jhodgdon meant was to integrate the link in the referenced paragraph. At least that makes sense to me. And also: Given that the list now only contains one single item, it should not be a list, but should be integrated in one sentence ("For further information about releases and release numbers see @link ...").

kotnik’s picture

Status: Needs work » Needs review
FileSize
1.92 KB

Got it, here's corrected patch.

jhodgdon’s picture

Status: Needs review » Needs work

That's good, just don't put the link text in parentheses:
+ * @link http://drupal.org/node/711070 (Maintaining a drupal.org project with Git) @endlink
(sorry, I missed that in your original patch)

See
http://drupal.org/node/1354#links

kotnik’s picture

FileSize
1.92 KB

Sorry I missed that as well. Patch attached.

jhodgdon’s picture

Status: Needs work » Reviewed & tested by the community

That looks good! Thanks. And by the way, set an issue status to "needs review" to trigger the testing bot. :)

kotnik’s picture

Thanks, and I'll try to be more careful the next time. :)

sun’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/core/modules/system/system.api.php
@@ -2872,16 +2872,13 @@ function hook_install() {
+ * A good rule of thumb is to remove updates older than two major releases of Drupal.
+ * See hook_update_last_removed() to notify Drupal about the removals. For further

Exceeds 80 chars.

Note: Does not apply to the @link line.

kotnik’s picture

Status: Needs work » Needs review
FileSize
3.14 KB

Fixed.

Also fixed other lines in the same file that exceeded 80 chars limit.

jhodgdon’s picture

Status: Needs review » Needs work

I think it's best to limit this patch to fixing the issue reported and the text right around there. We're cleaning up general documentation issues (such as 80-character lines) in
#1310084: [meta] API documentation cleanup sprint
if you would like to help with that effort. Thanks!

kotnik’s picture

Status: Needs work » Needs review
FileSize
1.58 KB

Sure.

Patch attached.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks! I think this is ready to go now.

Dries’s picture

Status: Reviewed & tested by the community » Fixed

Committed to 8.x and backported to 7.x.

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

Issue summary: View changes

Typo fix