[folks] Clarify the documentation of PersonaStore.is_writeable



commit 4e60d645efa3df5f3f0abd3301aeff0d369227b8
Author: Philip Withnall <philip tecnocode co uk>
Date:   Tue Aug 2 23:20:07 2011 +0100

    Clarify the documentation of PersonaStore.is_writeable
    
    Closes: bgo#652657

 NEWS                     |    1 +
 folks/persona-store.vala |   10 ++++++++--
 2 files changed, 9 insertions(+), 2 deletions(-)
---
diff --git a/NEWS b/NEWS
index 85c202e..59b158a 100644
--- a/NEWS
+++ b/NEWS
@@ -27,6 +27,7 @@ Bugs fixed:
 * Bug 654907 â The writable store shouldn't be set by type_id
 * Bug 655745 â Implement read/write support for gender property
 * Bug 649296 â Folks backend files shouldn't begin with "lib"
+* Bug 652657 â Allow writing to properties of all personas
 
 API changes:
 * Swf.Persona retains and exposes its libsocialweb Contact
diff --git a/folks/persona-store.vala b/folks/persona-store.vala
index cdf3a69..d944046 100644
--- a/folks/persona-store.vala
+++ b/folks/persona-store.vala
@@ -466,8 +466,14 @@ public abstract class Folks.PersonaStore : Object
    /**
    * Whether the PersonaStore is writeable.
    *
-   * Only if a PersonaStore is writeable will changes to its { link Persona}s'
-   * properties be written out to the relevant backing store.
+   * Only if a PersonaStore is writeable will its { link Persona}s be updated by
+   * changes to the { link Individual}s containing them, and those changes then
+   * be written out to the relevant backing store.
+   *
+   * If this property is `false`, it doesn't mean that { link Persona}s in this
+   * persona store aren't writeable at all. If their properties are updated
+   * through the { link Persona}, rather than through the { link Individual}
+   * containing that persona, changes may be propagated to the backing store.
    *
    * PersonaStores must not set this property themselves; it will be set as
    * appropriate by the { link IndividualAggregator}.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]