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.

Sign up for GitHub

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

Jump to bottom

Codebase cleanup #238

Closed
4 tasks done
lchrusciel opened this issue Nov 8, 2017 · 4 comments
Closed
4 tasks done

Codebase cleanup #238

lchrusciel opened this issue Nov 8, 2017 · 4 comments
Labels
Maintenance

Comments

@lchrusciel
Copy link
Member

lchrusciel commented Nov 8, 2017 •
edited
Loading

We should enforce a few good practices inside the plugin:

  • Add strict types declaration to all classes
  • Remove assert in favour of type hints
  • Remove redundant doc blocks(for constructor for example)
  • Replace param docblocks with short syntax
@mamazu mamazu mentioned this issue Aug 31, 2018
Merged
@mamazu
Copy link
Member

mamazu commented Aug 31, 2018

Now this should be updated to:
✔️ Added strict types to classes (I checked with PHPStorm)
✔️ Remove assert in favour of typehints
⚫ Remove redundant doc blocks
⚫ Replace param docblocks with short syntax (what ever that means)

@lchrusciel lchrusciel mentioned this issue Aug 31, 2018
Merged
@mamazu
Copy link
Member

mamazu commented Sep 12, 2018

What do you mean with the short syntax?

@lchrusciel
Copy link
Member Author

For example https://github.com/Sylius/ShopApiPlugin/pull/307/files#diff-b7b599a1c07c6c9a437e7a82bb0086f3R17

It is done anyway ;)

@mamazu
Copy link
Member

mamazu commented Sep 12, 2018

Okay, I already started that but I wasn't sure if its the right one. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Maintenance
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Zales0123 @lchrusciel @mamazu