Comcast / Comcast/RestfulHttpsProxy

[Documentation] Add comments for important/public functions

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Go
Stars
14
Forks
3
PR merge metrics
No merged PRs in 30d

Description

## Problem
Sometimes a function name alone is not enough to describe what a function does. Adding documentation will improve the quality of the project and ease of use.

## Feature Description
Add comments for important private functions and all public functions

## Alternatives
Not adding documentation. (Everybody is unhappy, including the linter.)

## Additional Context
While the project is small, it should be straight forward, most important thing is to follow golang conventions. (https://blog.golang.org/godoc-documenting-go-code)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.