Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH docblock types #11168

Merged
merged 5 commits into from
Mar 12, 2024
Merged

ENH docblock types #11168

merged 5 commits into from
Mar 12, 2024

Conversation

lekoala
Copy link
Contributor

@lekoala lekoala commented Mar 4, 2024

Description

Fix/improve return types for public facing apis

Manual testing steps

Nothing, just phpstan being happy

Issues

Pull request checklist

  • The target branch is correct
  • All commits are relevant to the purpose of the PR (e.g. no debug statements, unrelated refactoring, or arbitrary linting)
    • Small amounts of additional linting are usually okay, but if it makes it hard to concentrate on the relevant changes, ask for the unrelated changes to be reverted, and submitted as a separate PR.
  • The commit messages follow our commit message guidelines
  • The PR follows our contribution guidelines
  • Code changes follow our coding conventions
  • This change is covered with tests (or tests aren't necessary for this change)
  • Any relevant User Help/Developer documentation is updated; for impactful changes, information is added to the changelog for the intended release
  • CI is green

Copy link
Member

@kinglozzer kinglozzer left a comment

Choose a reason for hiding this comment

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

One minor tweak, otherwise good to merge

src/Control/HTTPRequest.php Outdated Show resolved Hide resolved
@GuySartorelli
Copy link
Member

GuySartorelli commented Mar 7, 2024

Can you please tick all of the appropriate checkboxes? It's intended both as a "have I done everything I need to?" checklist for you, as well as a "Is the contributor finished working on this or is it clear there is still more to do?" list for maintainers.
As it stands, with none of the boxes ticked, it looks like this isn't even ready to be reviewed.

@GuySartorelli
Copy link
Member

Please also link to an open issue - we can't track closed issues

Co-authored-by: Loz Calver <kinglozzer@gmail.com>
@lekoala
Copy link
Contributor Author

lekoala commented Mar 8, 2024

@GuySartorelli issue created #11173

Copy link
Member

@GuySartorelli GuySartorelli left a comment

Choose a reason for hiding this comment

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

LGTM, it's an all 'round incremental improvement with no discernable side effects.

Please change the commit message from FIX to either MNT or ENH - FIX is for bugs that affect code, but this doesn't affect any of the actual code.

@GuySartorelli GuySartorelli mentioned this pull request Mar 10, 2024
4 tasks
@lekoala lekoala changed the title FIX docblock types ENH docblock types Mar 12, 2024
@GuySartorelli
Copy link
Member

Ahh, I didn't notice this has a bunch of commits, so I'll have to squash merge anyway, so I can change the commit message during that process.

@GuySartorelli GuySartorelli merged commit b031ade into silverstripe:5.1 Mar 12, 2024
15 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.

None yet

3 participants