You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 and clear commands are intended to have a larger font size than their Parameter fields and Return 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 teach argo how to do this. Here is what the markdown for the tables above look like, for reference:
Cryptol Module Management
=========================
Loading Modules
---------------:Method name:
``SAW/Cryptol/load module``
:Parameters:
- ``module name``: The name of the Cryptol module to be loaded.
Loading Files
-------------:Method name:
``SAW/Cryptol/load file``
:Parameters:
- ``file``: The name of the Cryptol source file to be loaded.
The text was updated successfully, but these errors were encountered:
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: