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

FIX: clean up documentation and modernise code #159

Closed
wants to merge 1 commit into from

Conversation

sunnysideup
Copy link

@sunnysideup sunnysideup commented Jul 16, 2024

Nothing special here, just a quick cleanup. Do with it as you please (happy for someone else to commit properly).

Description

Manual testing steps

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

@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.

I've added back the pull request template that you deleted. I've asked you this before but please don't delete the template - fill it out completely instead. I will start automatically closing your pull requests if you continue to ignore this request.

The template is there to speed up the process for everyone - it gives an immediately clear indication of what state the pull request is in, and ensures you do things like for example set the correct commit message (please read that link and change the commit prefix to ENH - this is not a bug fix) without needing to be asked.

public function getAllowedChildren(SiteTree $parent = null)
public function getAllowedChildren(SiteTree $parent = null) : array
Copy link
Member

Choose a reason for hiding this comment

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

Can't strictly type the return type outside of a major release.

return $children;
return (array) $children;
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this already an array? Why are you casting this here?

@GuySartorelli
Copy link
Member

Your message in the pull request description implies you might not be interested in making the requested changes - if that's the case please just close the PR. While I appreciate your intentions, opening pul requests that you don't intend to see through to their conclusion is not helpful.

@GuySartorelli
Copy link
Member

Closing as there hasn't been any response in almost a month

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