Invert API docs to point from NG to OG

python-attrs / attrs

Python Classes Without Boilerplate

https://www.attrs.org/

MIT License

5.3k stars 374 forks source link

Invert API docs to point from NG to OG #1316

Closed hynek closed 3 months ago

hynek commented 3 months ago

People use and love the new APIs, we've got the Pont Neuf problem, let's invert the API docs.

define()
- https://attrs--1316.org.readthedocs.build/en/1316/api.html#attrs.define
- https://attrs--1316.org.readthedocs.build/en/1316/api-attr.html#attr.s
field()
- https://attrs--1316.org.readthedocs.build/en/1316/api.html#attrs.field
- https://attrs--1316.org.readthedocs.build/en/1316/api-attr.html#attr.ib

cipri-tom commented 3 months ago

Well, in https://attrs--1316.org.readthedocs.build/en/1316/api.html#attrs.define , the doc string should also be modified so that

according to the specified attributes using attr.field or these

rather than

according to the specified attributes using attr.ib or these

hynek commented 3 months ago

Well, in https://attrs--1316.org.readthedocs.build/en/1316/api.html#attrs.define , the doc string should also be modified so that

according to the specified attributes using attr.field or these

rather than

according to the specified attributes using attr.ib or these

thanks!