Skip to content
This repository has been archived by the owner on Sep 24, 2020. It is now read-only.

Add analyzer descriptions #238

Merged
merged 1 commit into from
Oct 12, 2016
Merged

Add analyzer descriptions #238

merged 1 commit into from
Oct 12, 2016

Conversation

ddmler
Copy link
Collaborator

@ddmler ddmler commented Oct 12, 2016

Hey!

Type:

Link to issue: #234

This pull request affects the following components (please check boxes):

  • Core
  • Analyzer
  • Compiler
  • Control Flow Graph
  • Documentation

In raising this pull request, I confirm the following (please check boxes):

  • I have read and understood the Contributing Guidelines.
  • I have checked that another pull request for this purpose does not exist.
  • I wrote some tests for this PR.

Small description of change:

Added descriptions to analyzers, min php version for finalstatic analyzer, updated documentation.
Would be cool if dump-reference command could output the documentation file so we only have to update the texts once.

@@ -9,6 +9,8 @@

class ArgumentUnpacking extends AbstractFunctionCallAnalyzer
{
const DESCRIPTION = 'Checks for use of `func_get_args()` and suggests the use of argument unpacking. (... operator)';
Copy link
Collaborator

Choose a reason for hiding this comment

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

Shouldn't this analyzer require PHP >= 5.6?

Copy link
Owner

Choose a reason for hiding this comment

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

Yes, I will push related changes @K-Phoen

@K-Phoen
Copy link
Collaborator

K-Phoen commented Oct 12, 2016

Great work! 👍

Could you also add a commit to update the .phpsa.yml file?
You can re-generate-it using ./bin/phpsa config:dump-reference > .phpsa.yml

@K-Phoen
Copy link
Collaborator

K-Phoen commented Oct 12, 2016

Would be cool if dump-reference command could output the documentation file so we only have to update the texts once.

I don't think that this command should dump this documentation. But we definitely could provide another command to dot it :)

@ovr ovr merged commit 9dffcdc into ovr:master Oct 12, 2016
@ovr
Copy link
Owner

ovr commented Oct 12, 2016

Thanks @ddmler! 🐟

@ddmler ddmler deleted the config-descriptions branch October 12, 2016 12:42
@ddmler
Copy link
Collaborator Author

ddmler commented Oct 12, 2016

@K-Phoen I got confused with the command. Then we need a new one 👍
I had added a short list which of them need a min php version in issue #234

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants