search

UTDNebula / api-tools

CLI-based tool which facilitates the scraping, parsing, and uploading of data for Nebula Labs' API.
MIT License
5 stars 11 forks source link

Generate api-tools documentation via Godoc #23

Open jpahm opened 7 months ago

jpahm commented 7 months ago

This repo would benefit greatly from better, more consistent documentation.

We should look into using Godoc alongside updating and improving the documentation already present in the code.

This should be a fairly easy task, but whoever works on it will need to make sure they understand what they're documenting and should reach out with any questions if uncertainties arise so that documentation is as accurate as possible.

mikehquan19 commented 1 week ago

I'd like to work on this.

jpahm commented 1 week ago

I'd like to work on this.

All yours!