emberjs/ember.js

Public `setModifierManager` is not documented

Open

#18.967 aperta il 12 mag 2020

Vedi su GitHub
 (3 commenti) (3 reazioni) (0 assegnatari)JavaScript (4216 fork)batch import
DocumentationHelp Wanted

Metriche repository

Star
 (22.437 star)
Metriche merge PR
 (Merge medio 11g 14h) (20 PR mergiate in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Individua il file sorgente per setModifierManager nel repository ember.js e aggiungi commenti JSDoc che descrivano il suo scopo e i parametri come specificato nell'RFC.
Tech stack
javascript
Dominio
frontend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Ember.js basicsdocumentation writing
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90