OSC / osc-machete

High level interface to submitting and checking the status of batch jobs (currently OSC specific)
MIT License
1 stars 0 forks source link

Is there a better name for status_human_readable #42

Closed brianmcmichael closed 8 years ago

brianmcmichael commented 9 years ago

There is a FIXME: in simple_job/statusable.rb

FIXME: better name for this?
def status_human_readable

I'm removing the fixme and putting this issue up for reference.

ericfranz commented 9 years ago

This status value object https://github.com/AweSim-OSC/osc-machete/blob/c22faf7eeda01870f3a347ee9095fbf136fad19e/lib/osc/machete/status.rb (for addressing #32) provides an implementation of Object#inspect for this purpose.

According to ruby docs http://ruby-doc.org/core-2.2.2/Object.html#method-i-inspect the purpose of inspect is to return a

string containing a human-readable representation of obj. The default inspect shows the object’s class name, an encoding of the object id, and a list of the instance variables and their values (by calling inspect on each of them). User defined classes should override this method to provide a better representation of obj.

ericfranz commented 8 years ago

Will be addressed by https://github.com/AweSim-OSC/osc-machete/issues/32