Django

Code

Ticket #8533 (closed: fixed)

Opened 2 years ago

Last modified 2 years ago

Docs on model inheritance missing since r8506 (docs refactor)

Reported by: idangazit Assigned to: nobody
Milestone: 1.0 Component: Documentation
Version: SVN Keywords:
Cc: Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

Following docs refactor, I believe that all of the information regarding model inheritance that used to live in model-api is missing.

To be clear, I'm talking about model inheritance from the "old" docs. Additionally, information about the Meta option abstract isn't present in options.txt.

I don't know if this is by design, and can't find any tickets/changesets that indicate a change in behavior, so I think this is just a case of missing docs. If somebody can provide a positive indication that the old docs are still accurate, I'd be happy to copy the relevant missing sections into the new docs and provide a patch.

Attachments

Change History

08/29/08 01:44:08 changed by julien

  • needs_better_patch changed.
  • needs_docs changed.
  • stage changed from Unreviewed to Accepted.
  • needs_tests changed.
  • milestone set to 1.0.

This was reported again in #8667. This needs to be fixed by 1.0.

08/29/08 08:53:57 changed by julien

Just a few comments:

- Since model inheritance is a quite big subject on his own, maybe would it deserve its own separate page in the docs? My guess is that it was the original idea to remove the "Model Inheritance" section from the Model doc and move it to a separate topic page, but the new page would have slipped through in the process. Could Jacob confirm that?

- In the refactored docs, OneToOneField doesn't refer to parent_link any more, like it used to in the old docs.

- In the refactored docs, in the Serialization topic page, section on "Inherited models", all the links need to be fixed as they still point to the old doc: http://docs.djangoproject.com/en/dev/topics/serialization/#inherited-models

08/29/08 09:03:48 changed by julien

Also stressing that, as pointed by idangazit above, it'd be worth to mention abstract in the Meta options page.

08/29/08 21:03:14 changed by julien

I've opened a separate ticket, #8701, to fix all the references to the old doc. So for this ticket ignore my note about the serialization doc.

08/30/08 16:42:01 changed by richardb

I've sent in a patch for #8701 that fixes references to old doc except for this missing documentation - this makes the problem slightly easier to handle.

When the missing docs have been reinstated, there are a number of old-style docs links that will then need updating The files affected are:
docs/topics/serialization.txt
docs/topics/db/models.txt

I'd be happy to write a further patch when the model inheritance has been added back in.

08/31/08 05:14:39 changed by ubernostrum

  • status changed from new to closed.
  • resolution set to fixed.

(fixed in [8757])

Add/Change #8533 (Docs on model inheritance missing since r8506 (docs refactor))




Change Properties
Action