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

Removed requirement for a File-wide PHPDoc #12

Closed

Conversation

samsouder
Copy link

Basically, the file-wide PHPDoc seems a bit redundant in our modern code, as we require docs for classes and functions.

@johnmaguire
Copy link
Contributor

I think the reason we haven't removed this is we wanted to enforce "one or the other." Constants files for example don't have any classes in them. Though maybe the constants should be moved inside of classes.

@mrrsm
Copy link
Contributor

mrrsm commented Feb 23, 2016

Like @johnmaguire said most of our code isn't classes right now so it should have filedocs explaining what is in that file. If you are using codeclimate you can add an exclude for your project so it doesn't run that sniff in the meantime.

@samsouder samsouder closed this Nov 25, 2021
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.

3 participants