Closed (fixed)
Project:
Chaos Tool Suite (ctools)
Version:
8.x-1.x-dev
Component:
Exportables
Priority:
Normal
Category:
Task
Assigned:
Issue tags:
Reporter:
Created:
23 May 2012 at 13:49 UTC
Updated:
4 Jan 2014 at 02:05 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
damiankloip commentedComment #2
xjmComment #3
tim.plunkettI think this would be more clear if it were
!empty()and the unserialize call came firstMove this inside the conditional.
I realize this is how it was in
_ctools_export_unpack_object(), but no reason to define $info as an extra variable here since it's only used once below.Isn't $data an array here? Also probably best to switch the order of the ternary as above
Add a junk @todo please :)
It'd be marginally clearer to move this below the $expected_export definition, I'd think.
Comment #4
tim.plunkettCross post.
Comment #5
damiankloip commentedok, thanks timplunkett. Here is an updated version, with all your points taken care of.
Comment #6
tim.plunkettCommitted! http://drupalcode.org/project/ctools.git/commit/7a7b198
Comment #7
xjmWe committed this with @todo as a docblock? :P
Reopening for followup. :)
Comment #8
damiankloip commentedHave you checked out the 8.x branch? Currently almost all of the docblocks are @todo. I think we need a separate issue for these (to do a file at a time or something?), rather than re opening, then we will catch all of them. What do people think?
If not, then we probably want to do the same for the save, create, and delete issues.
Comment #9
merlinofchaos commentedWe already talked about this on IRC -- xjm is keeping us honest.
Tim and I were trying to be agile -- one of the things I hate the most is that if I document a design that I'm still trying to perfect, I am more likely to fail to notice that I changed a parameter and didn't adjust the documentation. On the other hand, @todo is impossible to miss. Thus, I thought it would be the most efficient use of time and ultimately lead to the most correct code to *really obviously* not be documented so that it can be done properly once we are confident the design is what we want.
And the reality proved it -- we changed method names and parameters a lot while working on it -- and it was even hard to make sure the interfaces matched.
I do think we probably want a single documentation issue, though, because MOST of the doc will probably come in a single pass. It may miss things, and we can do followup issues on it. Now that the design is pretty well solidified, a documentation pass should be an early priority.
Everyone okay with that approach? If so, I'd recommend opening a documentation issue, linking it here, and putting this one back to its previous state.
Comment #10
damiankloip commentedThis is how I imagined it would probably work. Once the code had established itself and settled a bit - then have a pass at the docs.
I didn't meant to sound harsh in #8 if that's how it came accross. xjm, I do appreciate your eagle documentation eye! :)
Comment #11
damiankloip commentedFixing this as other issues are now emerging for docs.