korakot / kora

Convenient tools for Colab

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

add documentation

kkasra12 opened this issue · comments

commented

can u please add documentation, please?

There are a lot of features to document. Do you have a specific need? Any feature you want first?

commented

i was interested to use python3.8 in colab,
and I find your rip in StackOverflow.

Even an overview of what's there would be great to have as a start.

@korakot I notice you're using fastcore, so you're likely aware of nbdev. One thing on my todo right now is to allow for "blank" notebooks to be made from the raw .py source code. This may help ease your documentation needs as much of it will be autogenerated. Here is a link to the issue/feature request for you to keep track of: fastai/nbdev#369

(Blank meaning take raw source code and build up foundational documentation w/ whatever source code is available, likely not comments though outside of functions)