search

endclothing / prometheus_client_php

Prometheus instrumentation library for PHP applications
https://prometheus.io/docs/concepts/metric_types/
Apache License 2.0
150 stars 77 forks source link

Remove unnecessary comments code #19

Open piotrooo opened 4 years ago

piotrooo commented 4 years ago

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 commented 4 years ago

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

piotrooo commented 4 years ago

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 commented 4 years ago

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! 👌

fernandesGabriel commented 4 years ago

@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 commented 4 years ago

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