api - Should changing the documented performance of a method be considered a breaking change? -

-

it seems common rule in software development once have deployed public api, especially if you've documented api (which—yeah, should have), must think long , hard before making changes break backwards compatibility api such changes breaking changes. in fact i'm sure many developers argue flat-out should not @ all, regardless of how long , hard may think it.

occasionally developer document performance of method. lot of msdn docs this, example, using big o notation. changing also constitute "breaking" change? maybe that's not clear question; put way: should avoided?

it seems me in cases where, e.g., might have developed superior algorithm solve problem, if had documented algorithm o(n2) might forgiven improving api replacing superior algorithm is, say, o(log n). users of api might notice , would, imagine, feel glad improvement.

on other hand wonder whether ever considered "excusable" worsen performance of component of api other reasons—e.g., optimize common use case results in worse performance in general case; optimize memory on cpu cycles or vice versa; eliminate external dependency had caused other issues, etc.

my intuition tells me improving performance ok. opposite? ok, assuming update documentation? wrong? i'm looking reasonable guidelines, here.

well, if make performance better doubt you'll complaints.

otherwise, i'd depends. if have access source code clients, upright thing through them , verify change won't cause them trouble.

if more complicated that, , liable make use-case's performance worse, should go talk clients , warn them of change.

if can't either (eg: shrink-wrapped api of kind), yeah, best implement change alternative call or something, , leave old call alone.


Comments

Post a Comment

Popular posts from this blog

java - SNMP4J General Variable Binding Error -

-
i trying use snmp4j snmp bulkget. when ever use snmp4j make call returned responseevent error says "general variable binding error" , data returned equal null. to debug: print out, console, exact oid , version number using in snmp4j. use printed out data snmpwalk on command line. valid results. know sending snmp4j correct pdu correct oid, version number, max repititions, etc. i have used snmp4j , code wrote succesffuly monitor other devices years. don't know different time. leaving me stumped. why "general variable binding error?" causes error? ideas debug? can reproduced? if so, first action should using wireshark or microsoft network monitor capture network packets. my guess agent gives generr response, not surprising, http://www.ietf.org/rfc/rfc1157.txt
Read more

windows - Python Service Installation - "Could not find PythonClass entry" -

-
i working on building python service. inducing error, not sure inducing it. ps c:\...> python .\file.py debug debugging service myservice - press ctrl+c stop. error 0xc00000f4 - not find service's pythonclass entry in registry error 1814 - specified resource name cannot found in image file. error 0xc0000080 - not locate module name in python class string (ie, no '.') this error coming pythonservicemessages.mc in pythonwin32. it turns out error result caused exception being thrown , python script dying off.
Read more

Determine if a XmlNode is empty or null in C#? -

-
the following code takes xmlnode data type , populates dataset object xmlnode content. write dataset's content file. public void populatedataset(xmlnode node) { xmlnodereader reader = new xmlnodereader(node); dataset ds = new dataset(); ds.readxml(reader); system.guid guid = system.guid.newguid(); string name = string.format("{0}{1}_{2}.xml", utility.xmloutputpath, utility.xmloutputfilename, guid.tostring()); //need write "node empty" file if xmlnode object empty of null ds.writexml(name, xmlwritemode.ignoreschema); } the problem encountered 1 scenario not write content file. how determine if xmlnode object null or empty? you can check if node parameter null or has innertext or innerxml properties null or empty, when enter method before creating xmlnodereader .
Read more