Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete documentation for ArrayField #1187

Open
deadaf opened this issue Jul 24, 2022 · 1 comment
Open

Complete documentation for ArrayField #1187

deadaf opened this issue Jul 24, 2022 · 1 comment

Comments

@deadaf
Copy link

deadaf commented Jul 24, 2022

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?

@HelgeKrueger
Copy link
Contributor

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 added a commit to HelgeKrueger/tortoise-orm that referenced this issue Sep 26, 2024
abondar pushed a commit that referenced this issue Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants