swiftlang / swiftlang/swift-corelibs-libdispatch
[SR-9329] Dispatch overlay desperately needs documentation
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 2.6k
- Forks
- 496
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 3
Description
| Previous ID | SR-9329 |
| Radar | None |
| Original Reporter | @lilyball |
| Type | Bug |
Environment
Apple Swift version 4.2.1 (swiftlang-1000.11.42 clang-1000.11.45.1)
Target: x86_64-apple-darwin18.2.0
Additional Detail from JIRA
| Votes | 0 |
| Component/s | libdispatch |
| Labels | Bug |
| Assignee | None |
| Priority | Medium |
md5: 69b16d2b08ab13c98778faa201c655b8
Issue Description:
The Dispatch overlay is almost completely lacking in documentation. This makes it very aggravating to use.
Contributor guide
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
The issue concerns the Dispatch overlay in the libdispatch component, but it names no files, tests, or specific APIs. Start by locating the overlay and reviewing its existing public documentation, then clarify the missing coverage with maintainers. Done means the requested Dispatch overlay usage is documented, with scope agreed before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100