search

aviaviavi / toodles

Project management directly from the TODOs in your codebase
MIT License
968 stars 35 forks source link

deleting a TODO item also deletes the line following #40

Open damiencourousse opened 5 years ago

damiencourousse commented 5 years ago

Let's consider the test file below. Deleting issue 2 also deletes the comment line -- another comment 2.

-- file: test.hs

-- another comment 0
-- TODO (assig|#test) - issue 1
-- another comment 1
-- TODO (assig|#test) - issue 2
-- another comment 2
-- TODO (assig|#test) - issue 3
-- another comment 3

The issue does not appear with this test file, where issue 2 is not followed by a comment line.


-- another comment 0
-- TODO (assig|#test) - issue 1
-- another comment 1
-- TODO (assig|#test) - issue 2

-- TODO (assig|#test) - issue 3
-- another comment 3
aviaviavi commented 5 years ago

Ah so this was actually the intended behavior - I figured that for a TODO could have multiple lines as part of the body. So toodles interprets a TODO body as continuing all the way until the contiguous comment lines end, or another TODO is seen.

Would you prefer TODO's for a single line comment only be that line? I'm open to changing the behavior, especially if any other people reading agree.

damiencourousse commented 5 years ago

On 31/10/2018 17:57, Avi Press wrote:

Ah so this was actually the intended behavior - I figured that for a TODO could have multiple lines as part of the body. So toodles interprets a TODO body as continuing all the way until the contiguous comment lines end, or another TODO is seen.

OK I see your point.

Would you prefer TODO's for a single line comment only be that line? I'm open to changing the behavior, especially if any other people reading agree.

Yes, I would vote for this one. At least in languages supporting single-line comments and multiple lines comments, I would expect TODOs as a single line in a single-line comment, and as the full block in comment blocks.

Reisen commented 5 years ago

If this does change, it would be wonderful if it could be an option. In Rust for example It's common to see multi-line comments using single line // for each line, and personally I'm relying on multi-line TODO notes as well. So I'd vote for current behaviour.