StageBase documentation in package_manager.api.php is incomplete

Created on 19 April 2023, over 1 year ago
Updated 3 May 2023, over 1 year ago

Problem/Motivation

@omkar.podey discovered at https://git.drupalcode.org/project/automatic_updates/-/merge_requests/83... for 📌 Create StageBase::stageDirectoryExists() for improved DX to see if stage directory exists. Fixed that package_manager.api.php is missing some documentation for StageBase:

Missing documentation for public methods:

  1. ::getStageDirectory()
  2. ::isApplying()
  3. ::isAvailable()

It made me discover something far worse: 📌 Rename Stage to StageBase to clarify its relationship to its subclasses, and add "Stage" suffix to the Updater classes Fixed renamed Stage to StageBase, but the documentation here was never updated 😳

Steps to reproduce

N/A

Proposed resolution

Update docs.

Remaining tasks

User interface changes

None.

API changes

None.

Data model changes

None.

📌 Task
Status

Fixed

Version

3.0

Component

Documentation

Created by

🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺

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

Comments & Activities

Production build 0.71.5 2024