emberjs/ember.js

Public `setModifierManager` is not documented

Open

#18,967 创建于 2020年5月12日

在 GitHub 查看
 (3 评论) (3 反应) (0 负责人)JavaScript (22,437 star) (4,216 fork)batch import
DocumentationHelp Wanted

描述

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!

贡献者指南

技术栈
javascripttypescript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of Ember.js
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
The issue requests documenting the public `setModifierManager` function. The source file is located at `packages/@ember/ internals/glimmer/lib/utils/custom modifier manager.ts`. Refer to the merged RFC (https://github.com/emberjs/rfcs/blob/f0a9b20d898013994b01670a35f868c229b2771b/text/0373 Element Modifier Managers.md) for the intended API and description. Add JSDoc comments to the function explaining its parameters (a function that takes an Owner and returns a manager instance, and a base class) and its purpose. Ensure the documentation follows existing patterns in the codebase.