gtalarico / pyairtable

Python Api Client for Airtable
https://pyairtable.readthedocs.io
MIT License
786 stars 139 forks source link

Documentation typo? #200

Closed NicoHood closed 1 year ago

NicoHood commented 2 years ago

Look at this: https://pyairtable.readthedocs.io/en/latest/orm.html

grafik

It says:

partner = fields.LinkField("Partner", "Contact", lazy=False)

The second parameter is a string. In the code itself this is documented as object: https://github.com/gtalarico/pyairtable/blob/main/pyairtable/orm/fields.py#L43

I guess that must be corrected in one of the two.

gtalarico commented 2 years ago

Good catch.

Doc should show model instance not str. I intended to support both but have not implemented. The str option allows circular referencing (django and my support similar approaches where it loads object by name reference)

image

mesozoic commented 1 year ago

This was resolved in #277; see https://pyairtable.readthedocs.io/en/stable/orm.html#linked-records