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

I built coffeedoctest from coffeedoc #18

Open
lmaccherone opened this issue Jan 15, 2012 · 2 comments
Open

I built coffeedoctest from coffeedoc #18

lmaccherone opened this issue Jan 15, 2012 · 2 comments

Comments

@lmaccherone
Copy link

You can find it here: https://github.com/lmaccherone/coffeedoctest. I haven't pushed it to npm yet but I'm hoping to figure out how to do that tomorrow.

@omarkhan
Copy link
Owner

Very nice! How would you feel about merging it into coffeedoc moving forward?

@lmaccherone
Copy link
Author

It's now up on npm as coffeedoctest. I would consider merging it. I see two big issues there and a few small ones. Big issues:

  1. We'd have to work out the syntax preference difference.
  2. We'd have to be convinced that folks wouldn't want to use them separately. Right now, I have it installed as two separate binaries so I can type coffeedoctest from the command line (actually my Cakefile as part of my test task) but I also have coffeedoc in my Cakefile as part of my docs task. We can easily handle the Cakefile thing with options, but it highlights the fact that some folks might want to use docco with coffeedoctest and I wouldn't want to discourage that. Then again, I switched from docco to coffeedoc. Maybe adding doctest capability would be the thing to tip more folks over to using our merged coffedoc/coffeedoctest. Thoughts? Anyone else reading have thoughts?

Minor issues:

  1. I hacked the original coffeedoc code up a bunch when creating coffeedoctest (although I perfectly preserved showdown's original behavior and just added an alternative path), so it would be a little work to get them to both work from the same codebase... unless we just did the processing serially by concatenating the code (yuk).
  2. --readme means something different in my pull request for coffeedoc than it does in coffeedoctest. Maybe you shouldn't merge that pull request until we decide. That's a minor thing that can easily be fixed though so I wouldn't want that to hold up a merge decision.

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

No branches or pull requests

2 participants