search

APItools / monitor

Track, transform and analyze the traffic between your app and the APIs you use.
https://www.apitools.com
MIT License
140 stars 23 forks source link

more documentation improvements #11

Closed mikz closed 9 years ago

mikz commented 9 years ago

as usual, here is the generated doc https://rawgit.com/APItools/monitor/documentation/doc/index.html

kikito commented 9 years ago

These two lines generate confusing description "Create event Creates Event" - https://github.com/APItools/monitor/blob/documentation/lua/models/pipeline.lua#L160-L161.

Same with Create Nofitication, json.encode/decode & HMAC-SHA-256. The "title line" gets "merged" with the text below it and it becomes a single line, which is confusing. I suggest removing title lines / merging with second line.

kikito commented 9 years ago

I think the http's option param should be clarified somewhere. A link to its full doc would be ok, if that doc exists.