Problem/Motivation

  • Check and align the comments at Drupal\k8s\Controller\ApiControllerInterface
  • The following is a list of CamelCase resource names (the other one is NOT CamelCame):
    • ConfigMaps
    • CronJob
    • DaemonSet
    • LimitRange
    • ReplicaSet
    • ServiceAccount
    • StatefulSet
  • See also the Glossary page: https://kubernetes.io/docs/reference/glossary/?all=true
  • Format:
    /**
 * Provides an interface defining a K8s <Resource Name or ResourceName> entity.
 *
 * @ingroup k8s
 */
  • For example:
    /**
 * Provides an interface defining a K8s LimitRange entity.
 *
 * @ingroup k8s
 */

    /**
 * Access controller for the K8s Network Policy entity.
 *
 * @see \Drupal\k8s\Entity\K8sNetworkPolicy.
 */

Issue fork cloud-3225220

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

yas created an issue. See original summary.

yas’s picture

yas
🇯🇵 he/him
Primary language Japanese
Location California 🇺🇸
commented
Issue summary: View changes
TamakiFujino’s picture

TamakiFujino commented
Assigned: Unassigned » TamakiFujino
Status: Active » Needs work

TamakiFujino opened merge request !385

TamakiFujino’s picture

TamakiFujino commented
Status: Needs work » Needs review
yas’s picture

yas
🇯🇵 he/him
Primary language Japanese
Location California 🇺🇸
commented
Status: Needs review » Needs work

@tamakifujino

Thank you for the refactoring. It looks good; and could I ask you to refactor further? That is, remove K8s:

BEFORE:

 * Provides an interface defining a K8s DaemonSet entity.

AFTER:

 * Provides an interface defining a DaemonSet entity.

Note that the following comments are exceptions since those are our own defined inteface, not K8s resources:

 * Provides an interface defining a K8s entity.

 * Provides an interface defining an exportable entity.

Please be careful about the article such as a and an.

TamakiFujino’s picture

TamakiFujino commented
Status: Needs work » Needs review
yas’s picture

yas
🇯🇵 he/him
Primary language Japanese
Location California 🇺🇸
commented
Status: Needs review » Reviewed & tested by the community

@tamakifujino

Thank you for the update. It looks perfect to me now. I'll merge the patch to 4.x and close this issue as Fixed.

yas closed merge request !385

  • yas committed 1537b1a on 4.x authored by TamakiFujino 
    Issue #3225220 by TamakiFujino, yas: Align the comments at Drupal\k8s\...
yas’s picture

yas
🇯🇵 he/him
Primary language Japanese
Location California 🇺🇸
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.