Skip to content

Commit 534eeff

Browse files
committed
updated readme
1 parent c7557cb commit 534eeff

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

readme.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
![GitHub License](https://img.shields.io/github/license/python-ffmpegio/python-namedpipe)
77
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/python-ffmpegio/python-namedpipe/Run%20Tests)
88

9-
Python only natively supports named pipes in Posix systems via `os.mkfifo`. This package extends the support to Windows and defines a `NPopen` class as a cross-platform solution to manage named pipes.
9+
Python natively supports named pipes only in Posix systems via `os.mkfifo`.
10+
This package extends the support to Windows and defines a `NPopen` class as
11+
a cross-platform solution to manage named pipes.
1012

1113
## Installation
1214

@@ -34,7 +36,6 @@ with NPopen('r+') as pipe: # bidirectional (duplex) binary pipe
3436
# - Windows: \\.\pipe\[0-9]+
3537

3638
# 3. Wait for the client to connect and create a stream
37-
# - accepts other open() arguments: buffering, encoding, error, newline
3839
# - blocks until connection is established
3940
# - returns an io-compatible stream
4041
stream = pipe.wait()
@@ -50,8 +51,8 @@ with NPopen('r+') as pipe: # bidirectional (duplex) binary pipe
5051

5152
stream.write(out_bytes)
5253

53-
# 5. automatically closes the stream and destroys the pipe object
54-
# when out of the contenxt
54+
# 5. the stream is automatically closed and the pipe object is destroyed
55+
# when comes out of the contenxt
5556
```
5657

5758
## API Reference

0 commit comments

Comments
 (0)