Comments (2)
Very nice! How would you feel about merging it into coffeedoc moving forward?
from coffeedoc.
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:
- We'd have to work out the syntax preference difference.
- 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 mydocs
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:
- 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).
--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)
- No --requirejs when installed via npm, version 0.1.11 HOT 2
- Sphinx integration HOT 2
- DocBlock before statements (functions) HOT 3
- Participate in DocSpec HOT 1
- weird stuff happens with classes defined in index.coffee HOT 3
- Does not generate html files only index.html HOT 3
- Flag to ignore files or folders HOT 3
- HtmlRenderer() has no method 'renderIndex' HOT 1
- reserved word "private" HOT 4
- Classes and Functions inside a top-level function won't be parsed HOT 5
- String literal in the beginning of the class declaration makes coffeedoc to fail HOT 3
- Hide non-public class methods from documentation HOT 1
- Class instance method not documented HOT 2
- Suggestion: headers beyond h2 HOT 1
- Ability to hide functions starting with _? HOT 2
- Class docstring is null when using tabs for indenting HOT 6
- Top-level documentation comment not parsed when preceded by another line HOT 2
- <Object> has no method 'existsSync' HOT 4
- Feature Request: Don't render AST nodes that aren't commented HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from coffeedoc.