wagtail / wagtail

A Django content management system focused on flexibility and user experience

Home Page:https://wagtail.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

`index.RelatedFields` example contradicts following documentation

ssyberg opened this issue · comments

index.RelatedFields documentation shows an example with a nested FilterField and then in the very next section says the example does not work.

Pertinent section of the Wagtail docs

Two related sections:

Details

I don't actually know which section is incorrect, the example or the documentation contradicting it. Here we have an example showing a FilterField in a RelatedField:
image

Then the very next sentence states:
"It’s not possible to filter on any index.FilterFields within index.RelatedFields"

Perhaps there's some other reason to declare a FilterField within a RelatedField but if so I think that should be clarified right here.