Skip to content
This repository has been archived by the owner on Aug 22, 2023. It is now read-only.

Documentation Updates #80

Open
runeimp opened this issue Jun 25, 2014 · 4 comments
Open

Documentation Updates #80

runeimp opened this issue Jun 25, 2014 · 4 comments

Comments

@runeimp
Copy link

runeimp commented Jun 25, 2014

Would love to see the docs updated regarding all the new features. Such as where options are set. It's nice that they're defined but I had to review the source to figure out they are defined via an object passed as the second argument to the constructor. Also to know if there are other hidden gems. :-)

@MoOx
Copy link
Contributor

MoOx commented Jun 26, 2014

It seems to be defined at the bottom of the api section https://github.com/segmentio/myth#nodejs
But you are right, we should make the options more visible.

@runeimp
Copy link
Author

runeimp commented Jun 27, 2014

Yes, defined but not demonstrated or noted that they are only usable as keys of an object passed as the 2nd argument to the constructor. And no command line usage for browsers or source options. Though after reviewing the source code I see source is inferred from the output file. ;-)

@MoOx MoOx added the need doc label Jun 28, 2014
@MoOx
Copy link
Contributor

MoOx commented Jul 14, 2014

@ianstormtaylor What do you think about moving options section after the example & eventually add a toc after the Why section ?

@ianstormtaylor
Copy link
Contributor

TOC sounds good, maybe even right at the top so its easier to find (before
the install header)

and sounds good re: options too!

On Sun, Jul 13, 2014 at 10:45 PM, Maxime Thirouin [email protected]
wrote:

@ianstormtaylor https://github.com/ianstormtaylor What do you think
about moving options section after the example & eventually add a toc after
the Why section ?


Reply to this email directly or view it on GitHub
#80 (comment).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants