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

Question about docblocks #51

Closed
ordago opened this issue Jun 11, 2022 · 3 comments · Fixed by #52
Closed

Question about docblocks #51

ordago opened this issue Jun 11, 2022 · 3 comments · Fixed by #52

Comments

@ordago
Copy link
Contributor

ordago commented Jun 11, 2022

There are many instances where the type and name of the parameters don't coincide (@param int $id 31 times).

https://github.com/yungifez/schooldash/blob/ffa14abc2feaf51fd6fbc0dcbcb794846c2bc942/app/Http/Controllers/AcademicYearController.php#L58-L62

In this case the casing of the parameters in the docblocks and the parameters in the method is different:

https://github.com/yungifez/schooldash/blob/ffa14abc2feaf51fd6fbc0dcbcb794846c2bc942/app/Services/User/UserService.php#L100-L108

My question is, are you using the docblocks? or are they just automatically generated.

Would you accept a PR fixing or deleting them?

@yungifez
Copy link
Owner

Its auto generated with laravel resource controllers

I never knew about the --model flag till recently when generating them

A fix pr would be appreciated

There's a lot on my plate with this project and things like that go un noticed

@yungifez
Copy link
Owner

Also would you like to be a moderator

@ordago
Copy link
Contributor Author

ordago commented Jun 11, 2022

If you don't use the docblocks you can publish the stubs of the controllers and remove them. That would be less visual noise.

No need to make me a moderator. I can only participate from time to time.

Good luck!

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 a pull request may close this issue.

2 participants