rubyworks / dnote Goto Github PK

Good idea to add a Rake task for DNote. Basically just copy the Syckle service.

Hi: I love Dnote so much I want use it for my other non ruby projects: yes I'm guilty; also write non ruby :(. So I want use other patterns than #LABEL: what about //LABEL: ? it is valid for java, C, Delphi.
Maybe options --premark --postmark can do the trick, by default :premark => '#' and :postmark => ':'
That's all!. Thanks for the useful Dnote project

I thing vert useful to cature some source lines for show in dnote report, i.e. copy some lines after the note. Sample
# FIXME: the count is incorrect
def counts
@CountS ||= (
h = {}
by_label.each do |label, notes|
h[label] = notes.size
end
h
)
end

Then the report shows something likes
FIXME: the count is incorrect
def counts
@CountS ||= (
h = {}
by_label.each do |label, notes|
...

The number of lines to capture can be a parameter.

Counts are not adding up correctly. It seems it is counting the number of files rather then the number of notes.

Version 1.7.0 of dnote aborts immediately because it cannot find dnote.yml.

In the future the parsing may imnprove to allow page-top outlined notes as well.

s/imnprove/improve/

Not a huge deal, but I didn't know where it would be best to submit this.

dnote --label FIXME generates this error. Could you pls fix it? Thx!

/tmp/test/vendor/gems/gems/dnote-1.1.4/lib/dnote/format.rb:45:in __send__': undefined methodlabels=' for #DNote::Format:0xb79102a0 (NoMethodError)
from /tmp/test/vendor/gems/gems/dnote-1.1.4/lib/dnote/format.rb:45:in initialize' from /tmp/test/vendor/gems/gems/dnote-1.1.4/lib/dnote/format.rb:44:ineach'
from /tmp/test/vendor/gems/gems/dnote-1.1.4/lib/dnote/format.rb:44:in initialize' from /tmp/test/vendor/gems/gems/dnote-1.1.4/lib/dnote/command.rb:121:innew'
from /tmp/test/vendor/gems/gems/dnote-1.1.4/lib/dnote/command.rb:121:in run' from ../../bin/../vendor/gems/gems/dnote-1.1.4/bin/dnote:3 from ../../bin/dnote:3:inload'
from ../../bin/dnote:3

Right now if we use gem bundler, the statistics are also for the code for gem, which we really dont want, it would be great if you could add an option to ignore directories. Thx!

Support context in more formats.

Text formats should be pretty easy, getting the indent right is the only tricky part there.

XML needs to put the text in CDATA. That might be difficult with way it's currently being handled.

$ dnote -T
/Library/Ruby/Gems/1.8/gems/dnote-1.3.0/lib/dnote/session.rb:224: warning: don't put space before argument parentheses
undefined method `group_by' for #Array:0x1123b34

DNote will sometimes pick up class or module names thinking they are notes.

To fix just ad a [^:](no extra colon) to the regexp for finding notes..

At the moment, it defaults & sorts by labels. It would great if u could add the option to sort by filename.

Thx for an awesome tool, its a boon to manage labels & developers!

When specifying path matchers via bash there is no way to specify a recursive search. So a -R option would be nice for that use case.

YARD documentation tool labels everything using @Label syntax. Including @todo. I am not 100% sure that a good idea b/c how does one distinguish a developer's note from an API annotation?

In any case, if somehow feasible, it might be nice to support this syntax too so that YARD and DNote can inter-operate well.