75lb / command-line-usage

A simple, data-driven module for creating a usage guide.
MIT License
210 stars 36 forks source link

Content { options, data } is not documented #7

Closed j-oliveras closed 7 years ago

j-oliveras commented 8 years ago

Content documentation has no reference to this possible content declaration (object with options and data, both optionals but one required).

Reading the source code, I understand that the option object has the same type as table-layout options and data has the same type as an array of objects decribed into Content document (the same as table-layout data).

Are my assumptions correct?

75lb commented 8 years ago

hi, yes you are correct across the board.. i didn't document that particular use case for Content as i felt neither table-layout nor its docs were yet complete enough to expose to users.. however, it is still functional and i used it in a few of the examples.. feel free to use, since you figured it all out..

j-oliveras commented 8 years ago

Thanks.

75lb commented 7 years ago

it's documented now