Rooba
/
attrs
mirror of https://github.com/python-attrs/attrs.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: fix intersphinx links

This commit is contained in:
Hynek Schlawack 2024-09-27 05:56:45 +02:00
parent 2afd663bf4
commit a59c5d7292
No known key found for this signature in database
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/glossary.md
View File

@ -97,7 +97,7 @@ slotted classes
- Since it's currently impossible to make a class slotted after it's been created, *attrs* has to replace your class with a new one.
While it tries to do that as graciously as possible, certain metaclass features like {meth}`object.__init_subclass__` do not work with slotted classes.
- The {attr}`class.__subclasses__` attribute needs a garbage collection run (which can be manually triggered using {func}`gc.collect`), for the original class to be removed.
- The {attr}`type.__subclasses__` attribute needs a garbage collection run (which can be manually triggered using {func}`gc.collect`), for the original class to be removed.
See issue [#407](https://github.com/python-attrs/attrs/issues/407) for more details.
- Pickling of slotted classes will fail if you define a class with missing attributes.

2
docs/why.md
View File

@ -114,7 +114,7 @@ Other often surprising behaviors include:
# ...
```
you end up with a class that has *two* `Point`s in its {attr}`__mro__ <class.__mro__>`: `[<class 'point.Point'>, <class 'point.Point'>, <type 'tuple'>, <type 'object'>]`.
you end up with a class that has *two* `Point`s in its {attr}`__mro__ <type.__mro__>`: `[<class 'point.Point'>, <class 'point.Point'>, <type 'tuple'>, <type 'object'>]`.
That's not only confusing, it also has very practical consequences:
for example if you create documentation that includes class hierarchies like [*Sphinx*'s autodoc](https://www.sphinx-doc.org/en/stable/usage/extensions/autodoc.html) with `show-inheritance`.