Skip to content

Commit 60166e3

Browse files
committed
fixes to README
1 parent 92f3da2 commit 60166e3

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,21 @@ One way to create the session object, assuming one has already successfully
4848
set up a client environment via `iinit`, is by using a simple `make_session`
4949
call:
5050

51+
```python
5152
>>> from irods.helpers import make_session
5253
>>> session = make_session()
54+
```
5355

5456
It is also possible to use the constructor form directly, passing
5557
connection and authentication options within the call parameter list:
5658

59+
```python
5760
>>> from irods.session import iRODSSession
5861
>>> with iRODSSession(host='localhost', port=1247, user='bob', password='1234', zone='tempZone') as session:
62+
```
5963

6064
Once created, an instance can be managed with an application-appropriate choice
61-
from a couple of possible patterns. Either the programmer can simply manage
65+
from a couple of possible patterns. Firstly, the instance can be managed
6266
the instance quite naturally, allowing reference counting to
6367
let it pass out-of-scope and destruct its server connection(s) at the
6468
proper time:
@@ -84,10 +88,10 @@ with make_session() as session:
8488
# the end of it, session.cleanup() is implicitly called.
8589
```
8690

87-
Either way, the instance remains available for further such use afterward,
91+
Either way, the instance remains available for further use afterward,
8892
until destructed.
8993

90-
We should, of course, be careful how many still-connected `iRODSSession`
94+
We should, of course, be mindful of how many still-connected `iRODSSession`
9195
objects we retain references to in an application, as having more of them than
9296
the system can support database connections for can result in spurious failure
9397
of iRODS client connections.

0 commit comments

Comments
 (0)