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

Remove unnecessary comments code #19

Open
piotrooo opened this issue Nov 10, 2019 · 5 comments
Open

Remove unnecessary comments code #19

piotrooo opened this issue Nov 10, 2019 · 5 comments
Labels
good first issue Good for newcomers

Comments

@piotrooo
Copy link

Since we have a 7.3 version comments from methods are not necessary because of types in signature.

That comments doesn't look pretty, and makes some unnecessary noise.

@NoelDavies
Copy link

I'd personally vote for keeping phpdoc blocks in. But remove inline comments where not needed.

@piotrooo
Copy link
Author

I was thought about reduntand params and return types. Doc comments which explains what do a public API method are ok and in libs code are generally good.

Comments from class fields which describes a type are also good (till 7.4).

@NoelDavies
Copy link

Please add a PR for this if you have any changes to make. We're working on getting a new release out soon, but could always do with extra help in the form of PRs! 👌

@NoelDavies NoelDavies reopened this Jan 6, 2020
@NoelDavies NoelDavies added the good first issue Good for newcomers label Jan 6, 2020
@gabrielfernandes-codes
Copy link

@NoelDavies I was reading the project since we will be using it on my company, and I was about to suggesting some tidying up and PSR 12 on some details. I can open a PR with a clean up of the methods phpdoc, or as on my style, make sure to add on everything to keep a standard, if is preferable to keep those comments

@NoelDavies
Copy link

Sorry @fernandesGabriel et all, I no longer work at EndClothing. The team there should manage this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants