[Docs] Python Dataclasses missing

Support
1

Hey hey, starting to document what I find/experience so I figured I can also add them to the forum.

I’m doing the 101 academy course which has lots of references to various dataclasses and methods naturally. However, various dataclasses that one might want to look up in documentation and read through the reference are missing in the docs.

There seems to have been this page in the past which still appears in the search: Python | Weaviate

But that’s no longer live (I think).

So tldr, 3 bits of feedback:

  • Having a docs page with a reference to the various dataclasses and what they are for/their init variables etc would be SUPER useful
  • If this page exists, there seems to be a problem with the discoverability
  • We should start linking to the docs reference pages for methods/classes mentioned in the Academy courses
2

hi @Tuana !! Welcome to Weaviate (again hehehe) and to our forums :hugs:

Is this what you are looking for?
https://weaviate-python-client.readthedocs.io/en/stable/genindex.html

I see a link to it from here:

For example, if you want to learn all about the connect_to_custom method

Let me know if that helps!

3

Hey Duda, I suppose that is what I’m looking for. Where in that page did you link to this? It’s quite difficult to discover I would say. Also not easy to navigate to the reference you need when you get there. I was looking for MetadataQuery for example.

Maybe I can raise this with the DevRel team…? Wdyt?

4

It is linked from here:

and also from the python client repo as well:

5

Indeed we could link it from more places :thinking: