[CHORE] Fix YUIDoc parse warnings
Open
Nobody has claimed this yet.
docs
- Dominant language
- JavaScript
- Stars
- 1.7k
- Forks
- 351
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 1
Description
When developing locally, there are many YUIDoc warnings that say "Missing item type", like so:
WARNING: ember-table/-private/utils/array.js:4: Missing item type
Genericizes `objectAt` so it can be run against a normal array or an Ember array
WARNING: ember-table/-private/utils/array.js:32: Missing item type
Cycle shift an internal [start..end] to [start + 1...end, start].
WARNING: ember-table/-private/utils/sort.js:32: Missing item type
An implementation of the standard merge sort algorithm.
These can generally be fixed by doing some combination of the following:
- add a
@classYUIDoc annotation in the file - add
@property+@typeannotations as needed, or - add
@method+@paramannotations as needed
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Run the local YUIDoc generation and begin with ember-table/-private/utils/array.js and ember-table/-private/utils/sort.js, which appear in the warnings. Review the nearby documentation and add the appropriate annotations described in the issue; done means the reported “Missing item type” warnings are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100