I've been thinking about ways that our API documentation could be made
a bit cleaner.
Currently, we use a lot of prose to describe APIs, their parameters,
and other nuances. I find this approach rather unique, and in some
ways obfuscating. We have great documentation in that we cover a lot
of
Hyrum K. Wright wrote:
I've been thinking about ways that our API documentation could be made
a bit cleaner.
Currently, we use a lot of prose to describe APIs, their parameters,
and other nuances. I find this approach rather unique, and in some
ways obfuscating. We have great
On Wed, Sep 15, 2010 at 11:35 AM, Julian Foad julian.f...@wandisco.com wrote:
Hyrum K. Wright wrote:
I've been thinking about ways that our API documentation could be made
a bit cleaner.
Currently, we use a lot of prose to describe APIs, their parameters,
and other nuances. I find this
On Mi, 2010-09-15 at 10:35 +0100, Julian Foad wrote:
Hyrum K. Wright wrote:
I've been thinking about ways that our API documentation could be made
a bit cleaner.
...
Thoughts?
-Hyrum
+1.
You know what, I've been a bit skeptical of the list-of-params style of
documentation, as
On 09/15/2010 05:35 AM, Julian Foad wrote:
Hyrum K. Wright wrote:
I've been thinking about ways that our API documentation could be made
a bit cleaner.
[...]
It's is really difficult to determine what each parameter does or what
possible errors are returned, without reading the entire
Hyrum K. Wright hyrum_wright at mail.utexas.edu writes:
Thanks. Though I'll probably wait a day or two, to let any dissenters
make themselves known. :)
-1/2. There are parts of your idea that I like, such as linking to common
documentation, enumerating all of the errors that can be returned,
On Wed, Sep 15, 2010 at 5:07 PM, Daniel Trebbien dtrebb...@gmail.com wrote:
Hyrum K. Wright hyrum_wright at mail.utexas.edu writes:
Thanks. Though I'll probably wait a day or two, to let any dissenters
make themselves known. :)
-1/2. There are parts of your idea that I like, such as linking
7 matches
Mail list logo
