summaryrefslogtreecommitdiff
path: root/python/decorators.py
blob: e02829f81ca89d27fde9d90d353ecc1d47b25c0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
def passive(cls):
	passive_note = '''
	
	.. note:: This object is a "passive" object. Any changes you make to it will not be reflected in the core and vice-versa. If you wish to update a core version of this object you should use the appropriate API.
'''

	if hasattr(cls, "__doc__") and cls.__doc__:
		cls.__doc__ += passive_note
	else:
		cls.__doc__ = passive_note

	return cls