Skip to content

[DOC] Add missing YUIDoc tags for @ember/helper exports#21236

Open
crazylogic03 wants to merge 2 commits intoemberjs:mainfrom
crazylogic03:fix/issue-20153-docs
Open

[DOC] Add missing YUIDoc tags for @ember/helper exports#21236
crazylogic03 wants to merge 2 commits intoemberjs:mainfrom
crazylogic03:fix/issue-20153-docs

Conversation

@crazylogic03
Copy link
Copy Markdown
Contributor

Resolves #20153. Adding missing @method, @for, @public, and @static tags for array, concat, fn, get, hash, and uniqueId in @ember/helper/index.ts so they appear in the documentation.

@crazylogic03
Copy link
Copy Markdown
Contributor Author

Hey @NullVoxPopuli !

The Linting CI job was failing earlier because Ember's custom lint:docs test enforces strict tracking of all exported documentations. Since my previous commit added YUIDoc tags for uniqueId, the docs generator picked it up as a new public API item, which caused the coverage test to flag it as "extraneous" because it wasn't listed in the expected output.

I have pushed a new commit to add uniqueId to

tests/docs/expected.js
to satisfy the coverage expectation. The npm run lint:docs check now passes perfectly locally, so this PR is clean, green, and ready for review whenever you have a moment! Thanks!

@NullVoxPopuli
Copy link
Copy Markdown
Contributor

@kategengler I think this PR would fix this page, where most of the exports are missing, ya? https://api.emberjs.com/ember/release/modules/@ember%2Fhelper

@kategengler
Copy link
Copy Markdown
Member

I need to check the end result of this being deployed. There are some particularities of the docs set up that mean it may not go where it is supposed to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Missing docs for several methods in @ember/helper

3 participants