How to properly document changes made to someone else's code

[pink]

I'm working on a library for CouchDB. I'm using the library EasyJSON for dealing with JSON documents.

I've made one very very small tweak in EasyJSON which overrides the function which converts numbered keys into a JSON array based on a custom property.

When I release this, what would be the proper way to document that I made a small change to someone else's library?

Code: Select all

/*
This function checks the keys of a LiveCode array,
and returns TRUE if all the keys are numerical - otherwise, returns false.

@param pArray a LiveCode array
@return TRUE if the array's keys are all numerical, otherwise FALSE
              UNLESS there is a customer property on the stack called numericOverride which has been set to TRUE 
*/
private function isNumericalArray pArray
     local tKeys,tOverride
     put the numericOverride of this stack into tOverride  ----added this
     if tOverride is false then return false   ----and this
     else
          put the keys of pArray into tKeys
          filter tKeys without "[0-9]*"
          if the number of lines in tKeys > 0 then return false
          else return true
     end if
end isNumericalArray

[richmond62]

How about something like this:

[mwieder]

You might submit a pull request to the original code so that your improvements can be incorporated into the library...

https://github.com/luxlogica/easyjson