Skip to content

Commit

Permalink
Update feature freeze information.
Browse files Browse the repository at this point in the history
There will be no Codo 2 based on CoffeeScript Redux, at least not for now.

To be honest, I'm a bit confused about Redux. I always had the impression
that Redux will be the official CoffeeScript V2, but it turns out this is not
the case for sure. It might happen sometimes, but not anytime soon. So the
current situation is that we now have two different CoffeeScript versions
that are incompatible in certain areas.

Since I'm anyways very short on time and need to reduce my time spent on
my various OSS projects, I officially cancel my plan for Codo 2 with this commit
and I'm not going to implement more features anytime soon.

* Closes coffeedoc#16
* Closes coffeedoc#72
* Closes coffeedoc#79
* Closes coffeedoc#81
* Closes coffeedoc#84
* Closes coffeedoc#89
* Closes coffeedoc#91
* Closes coffeedoc#94

If you'd like to see any of those features in Codo, please open a pull request.
  • Loading branch information
netzpirat committed Mar 25, 2013
1 parent ef0e744 commit b7be0cd
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 28 deletions.
23 changes: 9 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,16 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
* Update the CHANGELOG for noteworthy changes.
* Please **do not change** the version number.

## Feature freeze
## Features freeze

Codo has initially started as simple experiment to document the CoffeeScript class system and has quickly evolved to a
general documentation generator that supports many best practices that aren't part of CoffeeScript. I'd like to
continue extending Codo, but the code base has grown too fast and needs some architectural refactorings before more
features can be added.

**Until the architectural refactorings have been finished, no more features will be added to Codo.**

Planned tasks for Codo 2:

* Use CoffeeScript Redux for parsing.
* Remove the comment conversion and add comments to the CoffeeScript Redux parser instead.
* Switch from class to function focused approach.
* Abstract token detection into a tree walker.
* Separate structural analysis from the generator and referencer.
general documentation generator that supports many best practices that aren't part of CoffeeScript. Since every code
combination needs to be explicit detected and converted into an internal representation, it's a huge effort to support
everything that is possible with CoffeeScript. I've already implemented many features that I don't need for myself, and
since CoffeeScript is so damn flexible and powerful, many needs aren't covered yet.

**Since I have many other OSS projects I'd like to maintain and also enjoy my family in real life, I'm unable to add new
features to Codo for now. If you like to have a new feature in Codo, you need to implement it on your own and if you
open a pull-request, I'll happily assist you to find your way through the code base.**

Thanks for understanding.
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,22 +644,17 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
* Update the CHANGELOG for noteworthy changes.
* Please **do not change** the version number.

## Feature freeze
## Features freeze

Codo has initially started as simple experiment to document the CoffeeScript class system and has quickly evolved to a
general documentation generator that supports many best practices that aren't part of CoffeeScript. I'd like to
continue extending Codo, but the code base has grown too fast and needs some architectural refactorings before more
features can be added.

**Until the architectural refactorings have been finished, no more features will be added to Codo.**

Planned tasks for Codo 2:

* Use CoffeeScript Redux for parsing.
* Remove the comment conversion and add comments to the CoffeeScript Redux parser instead.
* Switch from class to function focused approach.
* Abstract token detection into a tree walker.
* Separate structural analysis from the generator and referencer.
general documentation generator that supports many best practices that aren't part of CoffeeScript. Since every code
combination needs to be explicit detected and converted into an internal representation, it's a huge effort to support
everything that is possible with CoffeeScript. I've already implemented many features that I don't need for myself, and
since CoffeeScript is so damn flexible and powerful, many needs aren't covered yet.
**Since I have many other OSS projects I'd like to maintain and also enjoy my family in real life, I'm unable to add new
features to Codo for now. If you like to have a new feature in Codo, you need to implement it on your own and if you
open a pull-request, I'll happily assist you to find your way through the code base.**

Thanks for understanding.

Expand Down

0 comments on commit b7be0cd

Please sign in to comment.