Skip to content

Remove redundant types and add specific array-types - #121

Merged
cviebrock merged 2 commits into
silverorange:masterfrom
gauthierm:remove-redundany-docblocks
Jul 30, 2025
Merged

Remove redundant types and add specific array-types#121
cviebrock merged 2 commits into
silverorange:masterfrom
gauthierm:remove-redundany-docblocks

Conversation

@gauthierm

@gauthierm gauthierm commented Jul 22, 2025

Copy link
Copy Markdown
Member

Description

Removes @property docblocks in favour of @var docs. Adds specific array types for local cache arrays.

See previous #120

Testing Instructions (optional)

Add step-by-step instructions for testing the PR, if necessary.

  1. Make sure Jenkins CI passes
  2. Make sure type inference in IDE still works.

Developer Checklist

Before requesting review for this PR, make sure the following tasks are
complete:

  • I added a link to the relevant Shortcut story, if applicable
  • I added testing instructions, if any
  • I made sure existing CI checks pass
  • I checked that all requirements of the ticket are fulfilled

Reviewer Checklist

Before merging this PR, make sure the following tasks are complete:

  • I made sure there are no active labels that block merge
  • I followed the testing instructions
  • I made sure the CI checks pass
  • I reviewed the file changes on GitHub
  • I checked that all requirements of the ticket (if any) are fulfilled

@gauthierm
gauthierm force-pushed the remove-redundany-docblocks branch from 82ac4bf to 86b2ce4 Compare July 25, 2025 18:31
Comment thread CME/dataobjects/CMEAccount.php
* @license http://www.opensource.org/licenses/mit-license.html MIT License
*
* @property int $id
* @property ?SwatDate $earned_date

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The @var where the property is defined should be made nullable too, I'd think.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The column in the DB is non-nullable.

@cviebrock
cviebrock merged commit 601b561 into silverorange:master Jul 30, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants