API page: https://api.drupal.org/api/drupal/core%21core.api.php/function/hook_mail...

The 'see also' isn't forming a link.

Also, the first mention of MailManagerInterface->mail() should probably be changed to API makes it into a link.

CommentFileSizeAuthor
#11 interdiff-2777451-5-11.txt1.21 KBmarkdorison
#11 see_references_not-2777451-11.patch3.9 KBmarkdorison
#5 references_to-2777451-5.patch3.86 KBmarkdorison
#2 D8-MailManagerInterface-2777451-2.patch483 bytespushpinderchauhan

Comments

joachim created an issue. See original summary.

pushpinderchauhan’s picture

pushpinderchauhan commented
Status: Active » Needs review
StatusFileSize
new D8-MailManagerInterface-2777451-2.patch483 bytes

Corrected the See also link but the one that is coming to description looks fine to me. It seems to be consistent with hook_mail_alter().

markdorison’s picture

markdorison
he/him
commented
Status: Needs review » Reviewed & tested by the community
alexpott’s picture

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

Let's fix all the instances of @see.*->

There are seven to fix in total.

markdorison’s picture

markdorison
he/him
commented
Title: references to MailManagerInterface in hook_mail() not forming links » @see references not forming links in documentation
StatusFileSize
new references_to-2777451-5.patch3.86 KB
markdorison’s picture

markdorison
he/him
commented
Status: Needs work » Needs review

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

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now 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.

quietone’s picture

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

Looks good to me. Applied patch and used grep to confirm that all 7 instances were fixed.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work 
  1. +++ b/core/includes/update.inc
@@ -596,7 +596,7 @@ function update_already_performed($module, $number) {
- * @see \Drupal::moduleHandler()->invokeAll()
+ * @see \Drupal::moduleHandler()::invokeAll()

    Should be @see \Drupal\Core\Extension\ModuleHandlerInterface::invokeAll() 

  2. +++ b/core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php
@@ -23,7 +23,7 @@ class Schema extends DatabaseSchema {
-   * @see DatabaseConnection_pgsql->queryTableInformation()
+   * @see DatabaseConnection_pgsql::queryTableInformation()

    Should be @see \Drupal\Core\Database\Driver\pgsql\Schema::queryTableInformation()

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented 
+++ b/core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php
@@ -23,7 +23,7 @@ class Schema extends DatabaseSchema {
    * This is collected by DatabaseConnection_pgsql->queryTableInformation(),
    * by introspecting the database.

Need to file a followup to fix or perhaps even remove this documentation. It's not useful tbh.

markdorison’s picture

markdorison
he/him
commented
Status: Needs work » Needs review
StatusFileSize
new see_references_not-2777451-11.patch3.9 KB
new interdiff-2777451-5-11.txt1.21 KB

Fixed issues described in #9.

quietone’s picture

quietone commented

Made a follow up issue as per #9, #2791375: Fix $tableInformation documentation in pgsql and mysql schema.php

quietone’s picture

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

Applied patch locally and the links are generated. Thx.

  • catch committed d262018 on 8.3.x 
    Issue #2777451 by markdorison, er.pushpinderrana, alexpott: @see...

  • catch committed a7e09eb on 8.2.x 
    Issue #2777451 by markdorison, er.pushpinderrana, alexpott: @see...

  • catch committed 380a407 on 8.1.x 
    Issue #2777451 by markdorison, er.pushpinderrana, alexpott: @see...
catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Committed/pushed to all three 8.x branches, thanks!

Status: Fixed » Needs work

The last submitted patch, 11: see_references_not-2777451-11.patch, failed testing.

daffie’s picture

daffie commented
Status: Needs work » Fixed

The patch was committed, so it will not apply again.

Status: Fixed » Closed (fixed)

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