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

fix: remove constructor doc comments #33

Merged
merged 6 commits into from
Mar 26, 2024
Merged

fix: remove constructor doc comments #33

merged 6 commits into from
Mar 26, 2024

Conversation

rishtigupta
Copy link
Contributor

@rishtigupta rishtigupta commented Mar 26, 2024

PR Description:

Drupal.org mentioned some fixes in order to let momento be listed in their index:

1. FILE: src/Client/MomentoClientFactory.php

  /**
   * MomentoClientFactory constructor.
   */
  public function __construct() {

FILE: src/MomentoCacheBackendFactory.php

  /**
   * MomentoCacheBackendFactory constructor.
   */
  public function __construct(

FILE: src/MomentoCacheBackend.php

  /**
   * MomentoCacheBackend constructor.
   */
  public function __construct(

The documentation comment for constructors is not mandatory anymore. If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

2. FILE: src/MomentoCacheBackendFactory.php

  public function __construct(
        MomentoClientFactory $momento_factory,
        CacheTagsChecksumInterface $checksum_provider
    ) {

FILE: src/MomentoCacheBackend.php

  public function __construct(
        $bin,
        $client,
        CacheTagsChecksumInterface $checksum_provider
    ) {

Function and method declarations are written on a single line

@rishtigupta rishtigupta marked this pull request as ready for review March 26, 2024 20:34
@rishtigupta rishtigupta merged commit afa32f1 into main Mar 26, 2024
5 checks passed
@rishtigupta rishtigupta deleted the fix/drupal-plugin branch March 26, 2024 20:39
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