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

Improve DriverInterface #847

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

uuf6429
Copy link
Member

@uuf6429 uuf6429 commented Jun 10, 2023

The changes are fully backword compatible.

@codecov
Copy link

codecov bot commented Jun 10, 2023

Codecov Report

Merging #847 (e96bbea) into master (2bec260) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #847   +/-   ##
=========================================
  Coverage     98.50%   98.50%           
  Complexity      345      345           
=========================================
  Files            23       23           
  Lines          1002     1002           
=========================================
  Hits            987      987           
  Misses           15       15           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

* @noinspection PhpMissingParamTypeInspection
* @noinspection PhpMissingReturnTypeInspection
* @noinspection ReturnTypeCanBeDeclaredInspection
* @noinspection PhpElementIsNotAvailableInCurrentPhpVersionInspection
Copy link
Member Author

Choose a reason for hiding this comment

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

I've mixed feeling if this should be here: Disabling these inspections makes it nicer for the developer to focus on the bigger problems, but it's also basically hiding some problems.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think those should be added. They are phpstorm-specific and those inspections are not suited for any code that has to respect semver anyway (outside of major version) so they should do a better job at deciding when they report things. If you care about getting a focused feedback from phpstorm, you will have to disable those inspections when working on open-source code for any code that is already released.

@@ -159,8 +167,8 @@ public function back();
/**
* Sets HTTP Basic authentication parameters.
*
* @param string|false $user user name or false to disable authentication
* @param string $password password
Copy link
Member Author

@uuf6429 uuf6429 Jun 10, 2023

Choose a reason for hiding this comment

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

Unfortunately, the IDE has this style rule not enabled by default.
If it's preferred to have this sort of style, I can roll it back - I'll drop in an .editorconfig rule for the future though.

Copy link
Member

Choose a reason for hiding this comment

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

for now, please keep the alignment there to minimize the diff.

@uuf6429 uuf6429 marked this pull request as ready for review June 10, 2023 14:05
* @noinspection PhpMissingParamTypeInspection
* @noinspection PhpMissingReturnTypeInspection
* @noinspection ReturnTypeCanBeDeclaredInspection
* @noinspection PhpElementIsNotAvailableInCurrentPhpVersionInspection
Copy link
Member

Choose a reason for hiding this comment

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

I don't think those should be added. They are phpstorm-specific and those inspections are not suited for any code that has to respect semver anyway (outside of major version) so they should do a better job at deciding when they report things. If you care about getting a focused feedback from phpstorm, you will have to disable those inspections when working on open-source code for any code that is already released.

#[Language('XPath')]
$xpath,
$char,
#[ExpectedValues([null, 'ctrl', 'alt', 'shift', 'meta'])]
Copy link
Member

Choose a reason for hiding this comment

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

We already indicate that in the phpdoc in an interoperable way. so -1 for adding a jetbrains-only info about it (phpstorm is able to read this info from the phpdoc already).

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, sorry I missed that. I'll roll it back. 👍

@@ -159,8 +167,8 @@ public function back();
/**
* Sets HTTP Basic authentication parameters.
*
* @param string|false $user user name or false to disable authentication
* @param string $password password
Copy link
Member

Choose a reason for hiding this comment

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

for now, please keep the alignment there to minimize the diff.

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.

None yet

2 participants