Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
vsajip committed Jul 21, 2023
1 parent 8b29334 commit ca8e378
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1048,7 +1048,7 @@ instance before you invoke the operation. When an operation with ``gpg`` is init
``python-gnupg`` buffers the data. At the end of the data stream, it will be called with
a zero-length bytestring (allowing you do any necessary clean-up).

If the ``on_data`` callable returns ``False``, the data will not be buffered by
If the ``on_data`` callable returns ``False``, the data will *not* be buffered by
``python-gnupg``. For any other return value (including ``None``), the data *will* be
buffered. (This slightly odd arrangement is for backwards compatibility.)

Expand Down Expand Up @@ -1090,7 +1090,7 @@ Example usages (not tested, error handling omitted):
class Processor:
def __init__(self, fn):
self.out = open(fn, 'w')
self.out = open(fn, 'w', encoding='utf-8')
self.decoder = codecs.getincrementaldecoder('utf-8')
self.result = ''
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
sphinxcontrib-spelling==7.6.2
sphinx<7
sphinx-rtd-theme>=1.2.2

0 comments on commit ca8e378

Please sign in to comment.