SDK-2825: Rework the documentation for evaluator #1931
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DmytroKlymanSpryker
requested review from
VadymSachenko,
lenadoc,
AlexSlawinski and
andriitserkovnyi
as code owners
DmytroKlymanSpryker
added
the
updated
| @@ -4,73 +4,120 @@ description: Reference information for evaluator tools. | |||
| template: howto-guide-template | |||
| --- | |||
|
|
|||
| This document explains how you can bypass issues with additional logic inside the dependency provider’s methods. | |||
| "Additional logic in dependency provider" check checks the way how plugins are registered in dependency provider on the project level. | |||
There was a problem hiding this comment.
Suggested change
| "Additional logic in dependency provider" check checks the way how plugins are registered in dependency provider on the project level. | |
| This document explains how the *Additional logic in dependency provider* check checks the way how plugins are registered in dependency providers on the project level. |
|
|
||
| ## Problem description | ||
|
|
||
| On the project level, developers use `if` constructs with variety of expressions in dependency providers to register the plugins in particular cases only. | ||
|
|
||
| Not all possible expressions are needed inside of the `if` statements for plugin registration and not all of them are supported. This check verifies that if an `if` construct is used for plugin registration, then only one of the following expressions is used: | ||
| Used expressions inside of the `if` statements should not complicate use the complicated logic in dependency provider. This check verifies that if an `if` construct is used for plugin registration, then only one of the following expressions is used: |
There was a problem hiding this comment.
Suggested change
| Used expressions inside of the `if` statements should not complicate use the complicated logic in dependency provider. This check verifies that if an `if` construct is used for plugin registration, then only one of the following expressions is used: | |
| Any expressions used inside of the `if` statements should not use complicated logic in the dependency provider. This check verifies that if an `if` construct is used for plugin registration, then only one of the following expressions is used: |
...ing-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md
Outdated
Show resolved
Hide resolved
...ing-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md
Outdated
Show resolved
Hide resolved
...ing-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md
Outdated
Show resolved
Hide resolved
...v/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md
Outdated
Show resolved
Hide resolved
...v/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md
Outdated
Show resolved
Hide resolved
...ing-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md
Outdated
Show resolved
Hide resolved
...elines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md
Outdated
Show resolved
Hide resolved
...elines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md
Outdated
Show resolved
Hide resolved
...v/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md
Outdated
Show resolved
Hide resolved
...v/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md
Outdated
Show resolved
Hide resolved
docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md
Outdated
Show resolved
Hide resolved
AlexSlawinski
approved these changes
Jun 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Ticket: https://spryker.atlassian.net/browse/SDK-2825
Checklist