Skip to content

Add better documentation to codebase - #4

Open
hojulian wants to merge 2 commits into
masterfrom
better-doc
Open

hojulian wants to merge 2 commits into
masterfrom
better-doc

Conversation

@hojulian

Copy link
Copy Markdown
Contributor

This PR adds detailed documentations to all go files in the repo (including readme).
The documentations are written with using godoc in mind, it should display nicely with godoc.

Added back the missing documentations to most of the files. Updated
Readme for better formatting.
Add go example for calling graderd.
@hojulian hojulian added the documentation Improvements or additions to documentation label Dec 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants