mapbox / mapbox/mapbox-navigation-ios
Stylable UI components should be documented.
Open
Nobody has claimed this yet.
documentation
jira-sync-complete
UI
- Dominant language
- Swift
- Stars
- 918
- Forks
- 326
- Avg merge
- 1h 16m
- Merged PRs (30d)
- 3
Description
In scope of this ticket UI components, which are available publicly and marked with `/// :nodoc:` should be documented. Some examples include classes in `Style.swift`, `WayNameView.swift`, `NextBannerView.swift` etc.
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
Review the public UI components marked with `/// :nodoc:` in Style.swift, WayNameView.swift, and NextBannerView.swift. Determine which components are in scope and document them consistently; done means the listed public components are documented and no longer unintentionally hidden by `:nodoc:`.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation, mobile
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100