Extend the docstring for obj_make_compatible() with examples
Extend the docstring for obj_make_compatible() with examples

This adds to the docstring for obj_make_compatible() to help outline
the rules and scenarios to help developers understand what they need
to do in that method, and when.

Change-Id: Ifa8cb9a4f9a1a4d5afd0da4629a7d476a52c62d6

cloudbase/nova-virtualbox,tealover/nova,Stavitsky/nova,TwinkleChawla/nova,varunarya10/nova_test_latest,badock/nova,BeyondTheClouds/nova,vladikr/nova_drafts,LoHChina/nova,jianghuaw/nova,openstack/nova,petrutlucian94/nova,yatinkumbhare/openstack-nova,alaski/nova,cernops/nova,rajalokan/nova,cloudbase/nova,MountainWei/nova,cyx1231st/nova,vmturbo/nova,redhat-openstack/nova,klmitch/nova,ruslanloman/nova,Yusuke1987/openstack_template,dims/nova,kimjaejoong/nova,edulramirez/nova,blueboxgroup/nova,joker946/nova,takeshineshiro/nova,berrange/nova,phenoxim/nova,felixma/nova,gooddata/openstack-nova,Tehsmash/nova,angdraug/nova,scripnichenko/nova,projectcalico/calico-nova,j-carpentier/nova,barnsnake351/nova,berrange/nova,openstack/nova,sebrandon1/nova,JioCloud/nova_test_latest,badock/nova,j-carpentier/nova,Yusuke1987/openstack_template,kimjaejoong/nova,whitepages/nova,Juniper/nova,dawnpower/nova,JioCloud/nova,watonyweng/nova,JioCloud/nova,rahulunair/nova,takeshineshiro/nova,alaski/nova,devendermishrajio/nova,Juniper/nova,nikesh-mahalka/nova,felixma/nova,mgagne/nova,gooddata/openstack-nova,orbitfp7/nova,cloudbase/nova,Metaswitch/calico-nova,mmnelemane/nova,ted-gould/nova,double12gzh/nova,jeffrey4l/nova,mandeepdhami/nova,bigswitch/nova,virtualopensystems/nova,alexandrucoman/vbox-nova-driver,devendermishrajio/nova_test_latest,zzicewind/nova,belmiromoreira/nova,mgagne/nova,mandeepdhami/nova,BeyondTheClouds/nova,silenceli/nova,Tehsmash/nova,projectcalico/calico-nova,saleemjaveds/https-github.com-openstack-nova,bgxavier/nova,hanlind/nova,klmitch/nova,gooddata/openstack-nova,akash1808/nova_test_latest,iuliat/nova,BeyondTheClouds/nova,affo/nova,nikesh-mahalka/nova,cernops/nova,vmturbo/nova,eonpatapon/nova,mikalstill/nova,klmitch/nova,varunarya10/nova_test_latest,vladikr/nova_drafts,yatinkumbhare/openstack-nova,tianweizhang/nova,openstack/nova,hanlind/nova,CEG-FYP-OpenStack/scheduler,akash1808/nova,jianghuaw/nova,JioCloud/nova_test_latest,JianyuWang/nova,mahak/nova,cloudbase/nova-virtualbox,blueboxgroup/nova,NeCTAR-RC/nova,cyx1231st/nova,cernops/nova,rahulunair/nova,maelnor/nova,JianyuWang/nova,apporc/nova,saleemjaveds/https-github.com-openstack-nova,petrutlucian94/nova,Francis-Liu/animated-broccoli,isyippee/nova,cloudbase/nova,noironetworks/nova,shail2810/nova,vmturbo/nova,tianweizhang/nova,angdraug/nova,apporc/nova,ted-gould/nova,Metaswitch/calico-nova,jianghuaw/nova,devendermishrajio/nova_test_latest,thomasem/nova,joker946/nova,orbitfp7/nova,alvarolopez/nova,dawnpower/nova,Francis-Liu/animated-broccoli,iuliat/nova,devendermishrajio/nova,CloudServer/nova,zaina/nova,bgxavier/nova,eonpatapon/nova,rajalokan/nova,yosshy/nova,sebrandon1/nova,silenceli/nova,zzicewind/nova,jeffrey4l/nova,redhat-openstack/nova,tudorvio/nova,zaina/nova,CloudServer/nova,tangfeixiong/nova,eayunstack/nova,ruslanloman/nova,rajalokan/nova,rahulunair/nova,tangfeixiong/nova,fnordahl/nova,sebrandon1/nova,adelina-t/nova,CCI-MOC/nova,yosshy/nova,scripnichenko/nova,CCI-MOC/nova,virtualopensystems/nova,watonyweng/nova,affo/nova,bigswitch/nova,barnsnake351/nova,NeCTAR-RC/nova,noironetworks/nova,isyippee/nova,vmturbo/nova,double12gzh/nova,eayunstack/nova,mmnelemane/nova,rajalokan/nova,Juniper/nova,mikalstill/nova,mahak/nova,Stavitsky/nova,Juniper/nova,dims/nova,edulramirez/nova,thomasem/nova,shail2810/nova,CEG-FYP-OpenStack/scheduler,tudorvio/nova,jianghuaw/nova,phenoxim/nova,fnordahl/nova,akash1808/nova,adelina-t/nova,alvarolopez/nova,LoHChina/nova,gooddata/openstack-nova,akash1808/nova_test_latest,zhimin711/nova,maelnor/nova,raildo/nova,klmitch/nova,tealover/nova,mikalstill/nova,TwinkleChawla/nova,raildo/nova,mahak/nova,MountainWei/nova,alexandrucoman/vbox-nova-driver,zhimin711/nova,whitepages/nova,belmiromoreira/nova,hanlind/nova