Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow pass-through flags for `spago docs` #294

Closed
elliotdavies opened this issue Jun 26, 2019 · 3 comments

Comments

@elliotdavies
Copy link
Contributor

commented Jun 26, 2019

purs docs accepts a --format flag that can be used to generate Markdown documentation and Vim/Emacs tags as well as HTML (the default). Currently spago docs doesn't accept any arguments, so you always get HTML. Could we allow e.g. spago docs -- --format ctags in the same way that spago build accepts pass-through arguments?

If we think it's a good idea, I'm sure I could PR this!

@justinwoo

This comment has been minimized.

Copy link
Collaborator

commented Jun 26, 2019

i've needed this sometimes as well, and using the same mechanism is probably easiest

@f-f

This comment has been minimized.

Copy link
Member

commented Jun 26, 2019

@elliotdavies sounds good!

However, I'd prefer to not pass arbitrary arguments to purs docs, but have --format as a Spago flag. This is because we'll need to do other stuff than just calling purs when having html output (see #89)
If @justinwoo needs other flags other than format, we can add them as Spago flags too

@elliotdavies

This comment has been minimized.

Copy link
Contributor Author

commented Jun 26, 2019

@f-f OK great - makes sense to me. I'll get on it!

@f-f f-f added the in progress label Jun 26, 2019

@elliotdavies elliotdavies referenced this issue Jul 1, 2019

Merged

Add `--format` flag to `spago docs` #299

2 of 3 tasks complete

@f-f f-f closed this in #299 Jul 2, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.