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

MNT Update @methods on class docblocks #84

Merged
merged 1 commit into from
Dec 17, 2023

Conversation

emteknetnz
Copy link
Collaborator

Comment on lines 13 to 14
* @method SilverStripe\ORM\HasManyList<EmailRecipient> EmailRecipients()
* @method SilverStripe\ORM\HasManyList<SubmittedForm> Submissions()
Copy link
Collaborator

@GuySartorelli GuySartorelli Dec 14, 2023

Choose a reason for hiding this comment

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

These are added through a trait.
I think it's correct for them to appear here (I'm unsure how @method annotations work with trait-to-class... maybe they just go on the trait and don't need to be here too?) - but we need to either import the EmailRecipient and SubmittedForm with use statements, or use the FQCN here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Having updated the docblock writer, using the FCQN here

Copy link
Collaborator

@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

@GuySartorelli GuySartorelli merged commit af4b3e3 into dnadesign:4.1 Dec 17, 2023
11 checks passed
@GuySartorelli GuySartorelli deleted the pulls/4.1/docblock branch December 17, 2023 20:05
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