Document which methods are disabled on RelatedManager if there's an intermediate tables

[Baptiste Mispelon]

The note at ​https://docs.djangoproject.com/en/dev/ref/models/relations/#django.db.models.fields.related.RelatedManager.set says:

Also, if you are using an intermediate model for a many-to-many relationship, some of the related manager’s methods are disabled.

It would be helpful to know exactly which methods are disabled.
From what I understand, add, create, and remove are disabled, but clear works.
The linked documentation (​https://docs.djangoproject.com/en/1.9/topics/db/models/#intermediary-manytomany) doesn't mention set at all.

[Ketan Bhatt]

It says ​here that:

1. "Unlike normal many-to-many fields, you can’t use add(), create(), or set() to create relationships"
2. "The remove() method is disabled"
3. "However, the clear() method can be used"

Should I link to this part of the documentation in the ​note in Related objects Reference, or just state that only clear() can be used?

[Baptiste Mispelon]

You're right, I was incorrect and set() is indeed mentionned (turns out I was reading the 1.9 version of the docs instead of the latest).

To me, it would be helpful to have the list of disabled method explicitly listed (that's what I expect from a reference documentation).
I was thinking of something along the lines of "[...] some of the related manager's methods are disabled (add, create, and set)".

What do you think?

Thanks.

[Ketan Bhatt]

Replying to bmispelon:

You're right, I was incorrect and set() is indeed mentionned (turns out I was reading the 1.9 version of the docs instead of the latest).

To me, it would be helpful to have the list of disabled method explicitly listed (that's what I expect from a reference documentation).
I was thinking of something along the lines of "[...] some of the related manager's methods are disabled (add, create, and set)".

What do you think?

Take a look at ​https://github.com/django/django/pull/6677 and tell me if that looks good to you

Thanks.

[Tim Graham <timograham@…>]

In 59523c06:

Fixed #26679 -- Documented which methods are disabled on RelatedManager if there's an intermediate table.

[Tim Graham <timograham@…>]

In c2dde75:

[1.10.x] Fixed #26679 -- Documented which methods are disabled on RelatedManager if there's an intermediate table.

Backport of 59523c06fe482232dad9dc63ef0baab63418196d from master

[Tim Graham <timograham@…>]

In d4266dca:

[1.9.x] Fixed #26679 -- Documented which methods are disabled on RelatedManager if there's an intermediate table.

Backport of 59523c06fe482232dad9dc63ef0baab63418196d from master