Closed (fixed)
Project:
Multiversion
Version:
8.x-1.x-dev
Component:
Documentation
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
22 Oct 2014 at 11:51 UTC
Updated:
16 Nov 2015 at 12:54 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
dixon_Comment #2
dixon_Comment #3
dixon_Comment #4
stevectorDick when you write "As a part of this ticket all the @todo's should also be removed from the source code." do you simply mean that this ticket should stay open until all todos are resolved? I imagine the first step is a patch like this one, but with a lot more additions, yes?
Comment #5
dixon_No, this issue can be closed once we've created separate issues here on d.o for all @todo's and removed those comments from the code. Your patch is right, just needs more of the same thing :)
I think it's also a good idea to drop-in all issues we create as part of this into a comment here, so it's easy to cross reference that all @todo comments got issues created for them.
Comment #6
dixon_@stevector Thinking more about this, should we instead perhaps place each
// @todo Foo barwith@todo See http://drupal.org/node/xxxinstead? I guess that would be clearer for contributors also looking at the code?Then each referenced issue would be responsible for removing the
@todo See http://drupal.org/node/xxxpart...Thoughts?
Comment #7
stevectorHi dixon_,
Sure, so far all I had done is used the "related issues" functionality when creating #2596783: Revisiting the revision tab on entity pages. I'll also compile those in the issue summary.
So, just to be really clear I think you're asking if the comments should be:
or
I'd prefer the second because it is easier to grep and see if if this task is completed :) And for hyper-pedantry, should we actually be using "@link"? http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutoria...
Perhaps
Comment #8
dixon_Reading the "inline {@link}" documentation is sounds like we should do this:
Based on the below example from: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutoria...
Comment #9
stevectorCool, I'll go with that.
Comment #10
stevectorA bigger patch is coming. Here's what it looks like so far.
Comment #11
stevectorI think I got them all. I used
grep -R todo * | grep -v linkto make the list of comments to update.Comment #12
stevectorComment #14
dixon_Seems like a CI failure. I re-queued the patch.
Comment #15
dixon_Single blank line should be enough.
Double blank line seems unnecessary here.
The line breaks here seem a bit strange :)
Comment #16
stevectorGood catches. Thanks!
Comment #18
dixon_Thanks a lot Steve! This brings us one big step closer to the first alpha release!
Comment #20
jeqq commented