search

davejacobs / letters

A tiny debugging library for Ruby
Other
271 stars 9 forks source link

Options should be documented in the readme #13

Closed muescha closed 12 years ago

muescha commented 12 years ago

it would be nice if all options for each letters are documented in the readme

why: as i see it for the kill command the max options is also importent, but not documented

davejacobs commented 12 years ago

The API options are outlined in the documentation, have you checked that out? READMEs are traditionally short and to the point, with installation and overview information. Does that make sense? I am certainly considering beefing up the README a little this weekend, but I'm not sure it needs full API information.

The k command you mention is not yet pushed to RubyGems so I haven't updated the documentation.

muescha commented 12 years ago

Ok. But it should have a notice that there are options (like a short reference cheet sheet) with a link below the list to see an explanation for each option

davejacobs commented 12 years ago

That's a great idea. I think I should have time for that this weekend.

davejacobs commented 12 years ago

That's a great idea. I think I should have time for that this weekend.

muescha commented 12 years ago

PS: just delete not wanted style from pull request ...

on api documentation page please add a name tag so links point directly to the section

(maybe include the documentation page also in this github repo)

blambeau commented 12 years ago

IMHO the first table, mostly because it allows jou to jump to the API for each letter.

davejacobs commented 12 years ago

This is great, just merged. FYI, the API headers all have ids (generated in JS) so your fragment links already work.