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

#1759 Cleanup before further optimizations #1762

Open
wants to merge 2 commits into
base: develop-2.4
Choose a base branch
from

Conversation

lbajsarowicz
Copy link

Not changing any feature, just cleanup from messy PHPDoc, lint the code, and remove unused imports.

@gonzaloebiz
Copy link
Collaborator

Can't accept this PR, the PR delete a lot of documentation at the start of a lot of scripts

@lbajsarowicz
Copy link
Author

@gonzaloebiz

The problem (and the reason for cleanup) is fact, that none of removed snippets bring any value to the table. Let's get through this with examples:

/**
* MailChimp Magento Component
*
* @category Ebizmarts
* @package MailChimp
* @author Ebizmarts Team <[email protected]>
* @copyright Ebizmarts (http://ebizmarts.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* @date: 11/29/17 1:55 PM
* @file: Mailchimp.php
*/

Does not bring any value to the table, as it describes:

  • Mailchimp Magento Component - This is already defined in composer.json of an extension
  • @category, @package - These elements are discouraged by Magento Coding Standard and redundant (information already included both in composer.json and namespace)
  • @author already included in composer.json
  • @license already included in composer.json
  • @date and @file (really?!) not necessary at all, discouraged by Magento Coding Standard

Additionally, your "Copyright Block" is inconsistent and is not included in most of the files, so with my change I introduce consistency across the table.

Not even mentioning these accidents while committing your work:

/**
* Created by PhpStorm.
* User: gonzalo
* Date: 3/12/18
* Time: 2:12 PM
*/

All the occurrences of Class name in PHPDoc above the class, that does not introduce any added value, gets removed. Example:

image

If you really want to bring any value to the table, either provide information that is not included in a class name or... remove the PHPDoc Block.

Apart from these, the remaining elements are Code Style adjustments and removal of unused imports. If you have anything in your mind saying "delete a lot of documentation" - Please let me know what of the removed snippets you consider valuable, I'll bring these back in the PR.

# Conflicts:
#	Ui/Component/Listing/Column/Monkey.php
#	Ui/Component/Listing/Column/Products.php
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.

2 participants