emberjs/ember.js

Public `setModifierManager` is not documented

Open

#18,967 opened on May 12, 2020

View on GitHub
 (3 comments) (3 reactions) (0 assignees)JavaScript (4,216 forks)batch import
DocumentationHelp Wanted

Repository metrics

Stars
 (22,437 stars)
PR merge metrics
 (Avg merge 11d 14h) (20 merged PRs in 30d)

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!

Contributor guide

Research direction
Locate the source file for setModifierManager in the ember.js repository and add JSDoc comments describing its purpose and parameters as specified in the RFC.
Tech stack
javascript
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Ember.js basicsdocumentation writing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90