Bug 852217 - Docs/comments lacking for stickshift plugins
Summary: Docs/comments lacking for stickshift plugins
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: OpenShift Online
Classification: Red Hat
Component: Pod
Version: 2.x
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ---
: ---
Assignee: Krishna Raman
QA Contact: libra bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-08-27 21:44 UTC by Luke Meyer
Modified: 2015-05-15 00:16 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-07-22 15:48:20 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Luke Meyer 2012-08-27 21:44:35 UTC
Description of problem:

Docs/comments lacking in crankcase: stickshift/controller/lib/stickshift-controller/lib/stickshift/*.rb

Also, contents are inconsistent.

  
Actual results:

No docs or comments in these files. Also, mongo_data_store.rb is an implementation, not an interface.


Expected results:

Of all the code in the product, the part that defines an interface for folks to swap in their own plugins seems like the best candidate for good documentation and comments, but neither is to be found here. Please supply both.

Also, either move mongo_data_store.rb to where it will not give the impression that it could be plugged-out, or abstract it properly.


Additional info:

mmcgrath said I should file bugs for these things :)

Comment 1 Mike McGrath 2012-10-10 19:00:01 UTC
Reassigning to Krishna

  - Bug Triage Meeting


Note You need to log in before you can comment on or make changes to this bug.