Skip to content

Commit ef597fa

Browse files
committed
more README mods.
1 parent 190fe32 commit ef597fa

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -836,10 +836,10 @@ Disabling AVU reloads from the iRODS server
836836
-------------------------------------------
837837

838838
With the default setting of reload = True, an iRODSMetaCollection will
839-
proactively read all current AVUs back from the iRODS server with
840-
each metadata write done by the client. This helps methods such as items()
839+
proactively read all current AVUs back from the iRODS server after any
840+
metadata write done by the client. This helps methods such as items()
841841
to return an up-to-date result. Changing that default can, however, greatly
842-
increase code efficiency if for example there are many AVU's must be added or deleted
842+
increase code efficiency if for example a lot of AVUs must be added or deleted
843843
at once without reading any back again.
844844

845845
```
@@ -854,12 +854,11 @@ from pprint import pp
854854
print(f"{current_metadata = }")
855855
```
856856

857-
858857
Subclassing iRODSMeta
859858
---------------------
860-
An experimental keyword option, `iRODSMeta_type`, exists which can be used to
861-
set up any iRODSMeta subclass as the translator between native iRODS metadata
862-
APIs and the way in which the AVUs thus conveyed should be represented to the
859+
The keyword option `iRODSMeta_type` can be used to set up any iRODSMeta
860+
subclass as the translator between native iRODS metadata APIs
861+
and the way in which the AVUs thus conveyed should be represented to the
863862
client.
864863

865864
An example is the `irods.meta.iRODSBinOrStringMeta` class which uses the
@@ -891,8 +890,8 @@ Whereas the content of native iRODS AVUs must obey some valid text encoding as
891890
determined by the resident ICAT DB, the above is a possible alternative - albeit
892891
one semantically bound to the local application that defines the needed
893892
translations. Still, this can be a valid usage for users who need a guarantee
894-
that any given octet string can be placed into metadata in a way that doesn't
895-
violate standard text encodings.
893+
that any given octet string they might generate can be placed into metadata without
894+
violating standard text encodings.
896895

897896
Atomic operations on metadata
898897
-----------------------------

0 commit comments

Comments
 (0)