Generate documentation for parameter and return fields with tables #162
Labels
Docs
Documentation
Feature
A new thing that would be good
Low-Hanging Fruit
Good first task to meet the code
Currently,
argo
's autogenerated documentation for each server method includes the method's parameters and results in subsections. They look like this:This is OK, but in my opinion, there is room for improvement. The sections for the
load
andclear
commands are intended to have a larger font size than theirParameter fields
andReturn fields
subsections, but the difference in size in pretty subtle. To make this more obvious, I think it would be better to format this information with RST tables, like what SAW's handwritten remote API documentation currently does. Here is what the that looks like:With tables, it's very obvious where one method stops and another begins, and it looks nicer overall. Currently,
argo
doesn't support autogenerating the markdown for RST tables, but I don't imagine that it would be terribly difficult to teachargo
how to do this. Here is what the markdown for the tables above look like, for reference:The text was updated successfully, but these errors were encountered: