lbryio / lbryio/wallet-sync-server
Proper doc comments
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Eventually we may have some sort of auto documentation tool hit this repo. We should comment functions, consts, etc with the canonical format for such things.
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
The issue does not name any files, tests, entry points, or documentation tool. First clarify the canonical Go comment format and the intended scope, then survey the repository's functions and constants. Done means the agreed declarations have consistent comments suitable for the future documentation tool.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100