taskBo-Keep - Tasks: task #11227, BoKeep DocStrings

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #11227: BoKeep DocStrings

Submitter:  -Deleted Account- <samuelpauls>
Submitted:  Mon 18 Jul 2011 08:41:22 PM UTC
   
 
Should Start On:  Mon 18 Jul 2011 12:00:00 AM UTC Should be Finished on:  Mon 18 Jul 2011 12:00:00 AM UTC
Category:  None Priority:  5 - Normal
Status:  Postponed Privacy:  Public
Assigned to:  None Percent Complete:  90%
Open/Closed:  Open Effort:  0.00

Sun 07 Aug 2011 03:58:18 PM UTC, comment #3: 

Done, except for merge back of "front end plugin enabled/disabled attribute change" which contains unsafe variable renames.  If the branch is used, it would be after 1.1.2.

-Deleted Account- <samuelpauls>
Tue 19 Jul 2011 11:11:27 AM UTC, comment #2: 

"Basic cleaning and docstringing." branch was enhanced and merged back to default 919:1dc6cb931e11
http://hg.savannah.gnu.org/hgweb/bokeep/rev/1dc6cb931e11

Inspected the diff carefully to verify that it was just comments/docstrings and unsued imports . A second look from someone else would be welcome.

After that, pain stakingly (all night!) started the branch "safe variable renames lost in docstring branch" to incorporate the variable rename changes that had been reversed but were actually all right and as a result had not been merged back above.

As the branch title suggests, the intent is to limit it to function and variable renames from before are safe, they don't get persisted anywhere.

Would like a second opinion (and actual testing) on this one and then it can be safely merged in on time for the 1.1.2 release.

Also branched off from that the "front end plugin enabled/disabled attribute change" branch to incorporate the variable rename acts that had been done and reversed that were dangerous and would break backwards compatibility.

This obviously needs a well planned out semi-automatic migration if the user approves (and backs up first!) and shouldn't happen until the next backwards incompatible release (1.2.0). Don't think we should rush this, once "safe variable renames lost in docstring branch" is merged to default "front end plugin enabled/disabled attribute change" will be very similar to default and shouldn't be too hard to keep mergable back to default with semi-regular merges into the branch.

Mark Jenkins <markjenkins>
Group administrator
Mon 18 Jul 2011 08:50:26 PM UTC, comment #1: 

No need to give every method/function a docstring, just do more of the main ones.

-Deleted Account- <samuelpauls>
Mon 18 Jul 2011 08:41:22 PM UTC, original submission:  

DocStrings should be added/improved in BoKeep's general framework (aka everything but plugins).

This will help new and intermediate contributors understand how the code works so they can be more efficient and make less mistakes.

-Deleted Account- <samuelpauls>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by markjenkins (Posted a comment)
  • -email is unavailable- added by samuelpauls (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2011-08-07 samuelpauls StatusNone Postponed
        Percent Complete0% 90%
        Assigned tosamuelpauls None

    Back to the top

    Powered by Savane 3.13-758e.
    Corresponding source code