search

izqui / todos

Get the TODO's in your code directly into Github Issues
70 stars 6 forks source link

Places issue link at end of line, not end of paragraph #45

Open samertm opened 10 years ago

samertm commented 10 years ago

I break up comments with line breaks, and todos will place the issue url at the end of the line with the TODO on it, and not at the end of the paragraph that describes the todo.

For example, this:

// TODO: lots of things // need to be fixed here.

Will be turned into:

// TODO: lots of things [Issue: github.com/blahblah/] // need to be fixed here.

Instead of:

// TODO: lots of things // need to be fixed here. [Issue: github.com/blahblhl]

rsyring commented 9 years ago

This is also a show-stopper for us due to the fact that we have style guide line-length limits. Tacking the issue onto the end of the line almost always breaks that.

rsyring commented 9 years ago

Maybe placing the issue on the line just under the TODO would be easier. Knowing the TODO line is going to be the Github issue, semantically the comment would then look like:

// TODO: subject // [Issue: https://github.com/...] // Body... // more body.... // etc.

izqui commented 9 years ago

That seems like a good idea. I will look into it! @rsyring @samertm