search

AlexMili / torch-dataframe

Utility class to manipulate dataset from CSV file
MIT License
67 stars 8 forks source link

API - documentation #10

Closed gforge closed 8 years ago

gforge commented 8 years ago

You have currently used a system similar to LDoc but it doesn't entirely follow those rules. It may be worth changing the syntax to something that provides an automated documentation for at least the API. Coming from R I'm used to using roxygen2 that handles this entire problem in an excellent fashion.

I also like the dok.unpack functionality and it basically takes care of all the documentation (except the return value). Ideally I would like to combine the dok.unpack with LDoc but I guess that would require adding an LDoc extension. I'm pretty sure that there is some way of getting the torch/dok to generate documentation but for a documentation package it is surprisingly poorly documented.

AlexMili commented 8 years ago

I am investigating the dok.unpack option :)

AlexMili commented 8 years ago

Since #17 I think dok is no longer a suitable solution. LDoc seems a good march for our needs.

gforge commented 8 years ago

I agree. I still feel though that named parameters are a good thing and I suggest we keep dok.unpack when the parameters are > 2

gforge commented 8 years ago

The API docs are now available in the development branch through argcheck. The remaining issue before closure is adding TOC and/or splitting into multiple files