GithubHelp home page GithubHelp logo

Comments (2)

omarkhan avatar omarkhan commented on September 24, 2024

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

from coffeedoc.

lmaccherone avatar lmaccherone commented on September 24, 2024

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.

from coffeedoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.