Skip to content
This repository has been archived by the owner on Feb 12, 2020. It is now read-only.

[Refactor] Add Documentation #28

Open
freddy5566 opened this issue Aug 26, 2019 · 0 comments
Open

[Refactor] Add Documentation #28

freddy5566 opened this issue Aug 26, 2019 · 0 comments
Assignees
@freddy5566
Labels
refactor Refactor the code

Comments

@freddy5566
Copy link
Member

freddy5566 commented Aug 26, 2019 •
edited
Loading

Feature Request

Motivation

golang is not as easy read as other language such as swift, js and python. It gotta rely on document to explain what's going on.

leave comments below this issue, we have to discuss the doc convention.

Steps

  1. read the official doc to know how to write a readable doc
  2. write doc on every function in this project

Design
@freddy5566 freddy5566 added the refactor Refactor the code label Aug 26, 2019
@freddy5566 freddy5566 self-assigned this Aug 26, 2019
@freddy5566 freddy5566 mentioned this issue Aug 26, 2019
Merged
7 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@freddy5566 freddy5566

Labels
refactor Refactor the code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@freddy5566