Bug 1004434

Summary:	Documentation should advise explicit update() call
Product:	[Fedora] Fedora	Reporter:	Lukáš Zachar <lzachar>
Component:	python-nitrate	Assignee:	Petr Šplíchal <psplicha>
Status:	CLOSED ERRATA	QA Contact:	Fedora Extras Quality Assurance <extras-qa>
Severity:	low	Docs Contact:
Priority:	low
Version:	19	CC:	ohudlick, psplicha
Target Milestone:	---	Keywords:	Documentation
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	python-nitrate-1.0-0.fc20	Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2014-05-18 22:53:59 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Lukáš Zachar 2013-09-04 15:50:51 UTC

Description of problem:

When using caching, the update() call is not guaranteed for nested objects.
Thus the explicit request to call update() manually should be documented (in bold;)

Version-Release number of selected component (if applicable):
python-nitrate-0.9-1.fc19.noarch

Actual results:
The only occurrences of 'update' in pydoc nitrate are in the context of:
"Automatically update data upon destruction."
and
"By default CACHE_OBJECTS is used. That means any changes to objects
are pushed to the server only upon destruction or when explicitly
requested with the update() method."

No need of the explicit update() call is hinted.

Expected results:
The necessity to call update() is mentioned and explained.


Version-Release number of selected component (if applicable):
python-nitrate-0.9-1.fc19.noarch

Comment 1 Petr Šplíchal 2013-10-30 23:17:36 UTC

Thanks for the bug. This should now be better documented:
https://github.com/psss/python-nitrate/commit/5c5043f

Comment 2 Fedora Update System 2014-04-11 15:25:42 UTC

python-nitrate-1.0-0.fc20 has been submitted as an update for Fedora 20.
https://admin.fedoraproject.org/updates/python-nitrate-1.0-0.fc20

Comment 3 Lukáš Zachar 2014-04-11 16:09:10 UTC

Great, thanks for fixing it. pydoc nitrate.cache now says:

 By default CACHE_OBJECTS is used. That means any changes to objects are
    pushed to the server only when explicitly requested with the update()
    method.

Comment 4 Fedora Update System 2014-05-18 22:53:59 UTC

python-nitrate-1.0-0.fc20 has been pushed to the Fedora 20 stable repository.  If problems still persist, please make note of it in this bug report.