tortoise-orm icon indicating copy to clipboard operation
tortoise-orm copied to clipboard

Complete documentation for ArrayField

Open deadaf opened this issue 3 years ago • 1 comments

Disclaimer: This is my first issue ever on github so kindly correct me if my format is incorrect.

I see that tortoise-orm now supports ArrayField with the 0.19.0 update but I couldn't find the documentation regarding that anywhere, neither in https://tortoise.github.io/ nor in https://tortoise-orm.readthedocs.io/en/latest/

Also since the documentation isn't completed yet or maybe I couldn't find ArrayField in docs, can you please attach an example snippet of ArrayField in use?

deadaf avatar Jul 24 '22 06:07 deadaf

I was also looking for this. The code for array field is at: https://github.com/tortoise/tortoise-orm/blob/main/tortoise/contrib/postgres/fields.py

The documentation should probably be at: https://tortoise.github.io/contrib/postgres.html

If there is no objection to it, I can create a pull request adding the:

.. autoclass:: tortoise.contrib.postgres.fields.ArrayField

to https://github.com/tortoise/tortoise-orm/blob/main/docs/contrib/postgres.rst

HelgeKrueger avatar Sep 25 '24 13:09 HelgeKrueger