Use a different description for "Deprecation contains"

Created on 28 January 2022, about 3 years ago
Updated 31 July 2024, 9 months ago

Problem/Motivation

The Deprecation contains field shown in pages like https://api.drupal.org/api/drupal/deprecated/8.8.x uses the following description.

Examples: "before Drupal 9", "in Drupal 8.4"

I tried both before Drupal 9 and in Drupal 8.4, but I did not get any result.

Proposed resolution

Change the description to Examples, when searching Drupal 8.7.x or prior, use: "before Drupal 9", "in Drupal 8.4"; or for Drupal 8.8.x and higher, use: "in drupal:8.8.0", "from drupal:9.0.0".

📌 Task
Status

Fixed

Version

2.0

Component

User interface

Created by

🇺🇸United States Todd Zebert Los Angeles, CA

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

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    Actually, with before Drupal 9 I get results.

    What Deprecation contains requires is simply text that needs to be present in the deprecation message. If the deprecation message does not contain before Drupal 9, the file containing that deprecation message will not shown as result.

    I am not sure it is necessary to change the description given for that form element, but I am not sure it is necessary a description either, given the form element title is Deprecation contains. (Type would require a description.)
    Deprecation contains could be changed to Deprecation message contains, if that makes clearer what that filter field is expecting.

    api.drupal.org now uses the 2.x branch.

  • Status changed to Needs work 9 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    The file that needs to be changed is config/install/views.view.api_listings.yml.

  • Pipeline finished with Failed
    9 months ago
    Total: 226s
    #216110
  • Status changed to Needs review 9 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    I removed the description and changed the label to Deprecation message contains.
    I removed the description because any example shown would end up with no results. For example, of I look for before Drupal 9, in Drupal 8.4, in drupal:8.8.0, or from drupal:9.0.0 in Drupal 12 code, chances are that I would not get any result. Furthermore, I am not sure it is necessary to provide examples, given that the text to search could be any possible combination of characters, including interface, a class name, or a method name.

  • First commit to issue fork.
  • Status changed to RTBC 9 months ago
  • 🇪🇸Spain fjgarlin

    The changes look good. I will deploy this change in the next api.drupal.org deployment, the MR can be merged to the module in any case.
    Thanks!

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    @fjgarlin Would an issue for adding a description to Type be welcome? I am not sure I know every value that filter accepts, but I can provide a MR for that.

  • Status changed to Fixed 9 months ago
  • 🇪🇸Spain fjgarlin

    If you scroll on the results, one of the column to the right is "type". The values are usually "class", "function", "property"... depending on the type of element. Issues/MRs welcome, tho in this case I don't think it might even be needed once you see the "Type" column.

    The above MR has now been deployed to the live site. Thanks!

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

Production build 0.71.5 2024