Skip to content

Commit 37bc6ef

Browse files
committed
Partially fix doctest
1 parent 7a59ae7 commit 37bc6ef

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/api.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Core
7474
... class C:
7575
... x = attr.ib()
7676
>>> attr.fields(C).x
77-
Attribute(name='x', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None)
77+
Attribute(name='x', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='x')
7878

7979

8080
.. autofunction:: attrs.make_class
@@ -246,9 +246,9 @@ Helpers
246246
... x = attr.ib()
247247
... y = attr.ib()
248248
>>> attrs.fields(C)
249-
(Attribute(name='x', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None), Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None))
249+
(Attribute(name='x', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='x'), Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='y'))
250250
>>> attrs.fields(C)[1]
251-
Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None)
251+
Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='y')
252252
>>> attrs.fields(C).y is attrs.fields(C)[1]
253253
True
254254

@@ -267,9 +267,9 @@ Helpers
267267
... x = attr.ib()
268268
... y = attr.ib()
269269
>>> attrs.fields_dict(C)
270-
{'x': Attribute(name='x', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None), 'y': Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None)}
270+
{'x': Attribute(name='x', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='x'), 'y': Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='y')}
271271
>>> attr.fields_dict(C)['y']
272-
Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None)
272+
Attribute(name='y', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='y')
273273
>>> attrs.fields_dict(C)['y'] is attrs.fields(C).y
274274
True
275275

docs/extending.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ So it is fairly simple to build your own decorators on top of ``attrs``:
1616
... @define
1717
... class C:
1818
... a: int
19-
(Attribute(name='a', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=<class 'int'>, converter=None, kw_only=False, inherited=False, on_setattr=None),)
19+
(Attribute(name='a', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=<class 'int'>, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='a'),)
2020

2121

2222
.. warning::
@@ -261,7 +261,7 @@ A more realistic example would be to automatically convert data that you, e.g.,
261261
Data(a=3, b='spam', c=datetime.datetime(2020, 5, 4, 13, 37))
262262

263263
Or, perhaps you would prefer alternative default field names.
264-
Noting, that ``field_transformer`` receives `attr.Attribute` instances before private-attribute handling.
264+
Noting, that ``field_transformer`` receives `attrs.Attribute` instances before private-attribute handling.
265265

266266
.. doctest::
267267

0 commit comments

Comments
 (0)