compnerd / compnerd/cassowary

Add documentation for types and functions

Open
#17 0 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Swift
Stars
58
Forks
9
PR merge metrics
No merged PRs in 30d

Description

It would be beneficial to add documentation for the interfaces to enable easier usage of the library. The eventual goal would be to provide proper generated documentation via DocC.

Contributor guide

No contributing guide indexed for this repository

Research direction

Begin by inventorying the library's public interfaces and checking the repository for existing documentation conventions. Add documentation for the relevant types and functions with wording suitable for eventual DocC generation. Done means the public interfaces are documented and the documentation builds if a DocC setup is present.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.