emberjs/ember.js

Public `setModifierManager` is not documented

Open

#18 967 ouverte le 12 mai 2020

Voir sur GitHub
 (3 commentaires) (3 réactions) (0 assignés)JavaScript (4 216 forks)batch import
DocumentationHelp Wanted

Métriques du dépôt

Stars
 (22 437 stars)
Métriques de merge PR
 (Merge moyen 11j 14h) (20 PRs mergées en 30 j)

Description

The merged RFC specifies a public import setModifierManager:

Ember will provide a new API to assign the modifier manager for a element modifier class:

// my-app/app/modifier/foo.js

import EmberObject from '@ember/object';
import { createManager } from './basic-manager';
import { setModifierManager } from '@ember/modifier';

export default setModifierManager(createManager, EmberObject.extend({
  // ...
}));

// my-app/app/modifier/basic-manager.js

// ...

export function createManager(owner) {
  return new BasicManager(owner);
}

setModifierManager takes two parameters. The first parameter is a function that takes an Owner and returns an instance of a manager. The second parameter is the base class that applications would extend from.

Currently, setModifierManager is undocumented:

https://github.com/emberjs/ember.js/blob/ef3688b0986d06f4902166d8433a0441ae70af46/packages/%40ember/-internals/glimmer/lib/utils/custom-modifier-manager.ts#L1-L5

We should document it!

Guide contributeur

Direction de recherche
Localisez le fichier source de setModifierManager dans le dépôt ember.js et ajoutez des commentaires JSDoc décrivant son objectif et ses paramètres comme spécifié dans le RFC.
Stack technique
javascript
Domaine
frontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Ember.js basicsdocumentation writing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90