Contrib.social

api.drupal.org Some classes not displaying documentation

Open on Drupal.org →
Created on 15 September 2023, about 1 year ago
Updated 21 September 2023, about 1 year ago

API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Database%...

Enter a descriptive title (above) relating to Connection.php, then describe the problem you have found:

This page is not displaying correctly on api.drupal.org which makes the documentation for the core Connection class completely inaccessible. Specifically, this page is focused on a file in core Drupal. As such, it should link to any classes it contains and clicking on "View source" should allow you to see the full contents of the file. However, this page does not list the classes it should contain (i.e. Connection) and when I click "View source" nothing happens. This is consistent on the most recent version of Firefox and Safari. An example of a file-focused page that works is Schema.php.

If I try searching for `Connection` in order to find the class, I will get a listing including all the variant classes (i.e. mysql, pgsql, sqlite) but not the core version. `Connection.php` does show up in the list as a file but just brings me to the same page described above.

I then tried to use the URL patterns to guess the URL of the Connection class.
Specifically, if https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Database%... is the URL for the Schema class in core/lib/Drupal/Core/Database/Schema.php
then it stands to reason that
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Database%... should be the URL of the Connection class in core/lib/Drupal/Core/Database/Connection.php.
However, this page is not found.

This has consistently been a problem for months... I just finally found some way to hopefully report it. Let me know if there is somewhere else such issues should be opened for better visibility by those maintaining api.drupal.org/

📌 Task
Status

Closed: duplicate

Version

2.0

Component
Documentation  →

Last updated 6 days ago

No maintainer
Created by

🇨🇦Canada laceysanderson

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @laceysanderson
  • Comment about 1 year ago →
    🇫🇷France guignonv

    I noticed the same issue, for month as well, and I think it started when Drupal 9.4/9.5 moved database drivers from core to core modules. ...but I may be wrong.

    Meanwhile, you can use the v9 (obsolete compared to D10+) doc here for easy browsing:
    http://api.hostdog.eu/api/drupal-9/drupal%21core%21lib%21Drupal%21Core%2...
    or read the source file directly but it's not very convenient. That's what I do for the moment (and I guess you too as well). ;)

    This issue is quite important for people willing to develop database drivers or tweak existing drivers.

  • Status changed to Closed: duplicate about 1 year ago
  • Comment about 1 year ago →
    🇳🇿New Zealand quietone

    @laceysanderson, this is a know problem.

    It can be fixed in the API project so I am moving this to that project. And it is also a duplicate of 🐛 Classes missing from Drupal 10 Fixed . See comment #7 in that issue for a link to test version of the new API project.

  • Comment about 1 year ago →
    🇪🇸Spain fjgarlin

    Thanks for moving and finding the duplicate.

    As mentioned in the related issue, this does not happen in the new D10 version of the site and we can view source, navigate to different classes, etc: https://api.stage.cluster.drupalsystems.org/api/drupal/core%21lib%21Drup...

    I know this is not live yet. See https://www.drupal.org/project/api/issues/3342815#comment-15199714 🐛 Classes missing from Drupal 10 Fixed for more details.

  • Comment about 1 year ago →
    🇨🇦Canada laceysanderson

    Great! Thank you as well for finding that other issue!!! And thank you for pointing to that D10 non-production version of the documentation!!!

    I had searched for issues relating to api.drupal.org many times over the last month as I was sure it must be posted somewhere but could not find it.

    Since the link to add an issue under the comment on api.drupal.org sent me to post under Drupal Core: Documentation I assumed that issues would be there.

    It would be really helpful if the new version of api.drupal.org pointed to the API module issue queue!

  • Comment about 1 year ago →
    cilefen

    @laceysanderson It think that is because there are two types of documentation issues:

    1. A problem with the current documentation page, fixable with a commit in Drupal Core. These are the most common kind.
    2. The documentation system itself is broken. That's this issue. These are rarer.
  • Comment about 1 year ago →
    🇪🇸Spain fjgarlin

    +1 on #6.
    I think it's the right workflow.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024