Skip to content

Sync up doctest code that generates samples #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
icemac merged 2 commits into from
Feb 9, 2026
Merged

Sync up doctest code that generates samples #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92c64b1
Sync up doctest code that generates samples
cjwatson Feb 9, 2026
66e7ae5
Merge branch 'master' into update-samples-properly
icemac Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

- Remove run-time dependency on ``setuptools``.

- Adjust ``narrative`` doctest so that the sample files it generates match
those in git again.


6.0 (2025-09-12)
================
Expand Down
27 changes: 13 additions & 14 deletions docs/narrative.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ that defined some things to be imported:

.. doctest::

>>> create_module(sample1 = '''
>>> create_module(sample1 = '''\
... print("Sampe 1 imported!")
...
... x = 1
Expand All @@ -101,14 +101,14 @@ that imports some names from this module:

.. doctest::

>>> create_module(sample2 = '''
>>> create_module(sample2 = '''\
... import zope.deferredimport
...
... zope.deferredimport.define(
... sample1='zope.deferredimport.sample1',
... one='zope.deferredimport.sample1:x',
... two='zope.deferredimport.sample1:C.y',
... )
... )
...
... three = 3
... x = 4
Expand Down Expand Up @@ -185,22 +185,21 @@ more complicated example.

.. doctest::

# >>> create_module(sample3 = '''
# ...
# >>> create_module(sample3 = '''\
# ... import zope.deferredimport
# ... import zope.deferredimport.sample4
# ...
# ... zope.deferredimport.define(
# ... sample1 = 'zope.deferredimport.sample1',
# ... one = 'zope.deferredimport.sample1:x',
# ... two = 'zope.deferredimport.sample1:C.y',
# ... )
# ... )
# ...
# ... x = 1
# ...
# ... ''')

# >>> create_module(sample4 = '''
# >>> create_module(sample4 = '''\
# ... import sample3
# ...
# ... def getone():
Expand Down Expand Up @@ -246,7 +245,7 @@ modules, as in:

.. doctest::

>>> create_module(sample5 = '''
>>> create_module(sample5 = '''\
... import zope.deferredimport
... zope.deferredimport.initialize()
...
Expand All @@ -256,12 +255,12 @@ modules, as in:
... sample1='zope.deferredimport.sample1',
... one='zope.deferredimport.sample1:x',
... two='zope.deferredimport.sample1:C.y',
... )
... )
...
... x = 1
... ''')

>>> create_module(sample6 = '''
>>> create_module(sample6 = '''\
... import zope.deferredimport.sample5
...
...
Expand All @@ -287,7 +286,7 @@ deferred imports:

.. doctest::

>>> create_module(sample7 = '''
>>> create_module(sample7 = '''\
... import zope.deferredimport
... zope.deferredimport.initialize()
...
Expand All @@ -296,7 +295,7 @@ deferred imports:
... x='zope.deferredimport.sample1:x',
... y='zope.deferredimport.sample1:C.y',
... z='zope.deferredimport.sample1:z',
... )
... )
... ''')

Now, if we use one of these variables, we'll get a deprecation
Expand Down Expand Up @@ -327,7 +326,7 @@ can use :func:`~.defineFrom` or :func:`~.deprecatedFrom` to do that:

.. doctest::

>>> create_module(sample8 = '''
>>> create_module(sample8 = '''\
... import zope.deferredimport
...
... zope.deferredimport.deprecatedFrom(
Expand All @@ -342,7 +341,7 @@ can use :func:`~.defineFrom` or :func:`~.deprecatedFrom` to do that:
... )
... ''')

>>> create_module(sample9 = '''
>>> create_module(sample9 = '''\
... print('Imported sample 9')
... a, b, c = range(10, 13)
... ''')
Expand Down