Shop OBEX P1 Docs P2 Docs Learn Events
Modifying Objects — Parallax Forums

Modifying Objects

g3cwig3cwi Posts: 262
edited 2012-03-10 14:13 in Propeller 1
Dear all

For my project I am having to modify some popular objects. I want to add my project to the OBEX eventually but the objects called will have to be the modified ones (of course). What is the correct way to go about this? Clearly the objects are not mine just because I have changed them a bit. Do I rename them and add a comment inside the object? What's the proper way to proceed? I don't want anyone getting annoyed!

Cheers

Richard

Comments

  • Dr_AculaDr_Acula Posts: 5,484
    edited 2012-03-10 05:03
    I tend to add comments near the beginning. So you have the original author with their comments and then any modifications all listed one by one.
    I don't want anyone getting annoyed!

    I've generally found people are pleased you are using their object. You are happy to get some code that almost does what you want. They are happy they helped someone. Smiles all round!
  • StefanL38StefanL38 Posts: 2,292
    edited 2012-03-10 05:06
    HI
    Richard,

    The one and only purpose of the OBEX is that people can using, modify and develope the objects.
    The details are regulated in the MIT-licence at the bottom of each OBEX-object. As long as you obey
    the rules of the MIT-licence I think everything is good.

    You should give the files of the object a clear name that differs obvioulsy from the "original" object.

    Why should somebody be annoyed if you contribute to his work?

    I have seen some other objects where the modifier made a comment like
    "modified object from ..." or "based on the object of ..."

    best regards
    Stefan
  • Cluso99Cluso99 Posts: 18,069
    edited 2012-03-10 13:14
    I tend to add an "_rr001" to the filename (my initials and a numeric sequence). I always note what I have modified in the code. See FullDuplexSerial_rr004.spin in the obex.

    This works great, leaves the attributions intact, and notifies what you have modified.
  • Phil Pilgrim (PhiPi)Phil Pilgrim (PhiPi) Posts: 23,514
    edited 2012-03-10 14:13
    I also add my initials to each line I add or change or to the beginning of each method that I add.

    -Phil
Sign In or Register to comment.