sunshinejr/SwiftyUserDefaults

Inline documentation

Open

#79 opened on Mar 2, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Swift (4,280 stars) (303 forks)batch import
help wanted

Description

A lot of SwiftyUserDefaults isn't well documented in code. It's documented on the GitHub page, but it would be great it you could alt+click on any SUD symbol in Xcode and have a decent description of it.

PR-s are most welcome ;)

Contributor guide

Tech stack
swift
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the public API of SwiftyUserDefaults (e.g., all public classes, structs, enums, functions, properties) and identify symbols that lack documentation comments. Add inline documentation using Swift's documentation comment syntax (/// or /** */) for each symbol, including description, parameter descriptions, and return value where applicable. The GitHub README contains high level documentation that can be adapted for inline comments. Issue #79 requests this improvement.