Opened 6 years ago

Last modified 2 years ago

#12096 assigned Bug

model attributes are not set toplevel which causes doctools to miss the attribute docstrings

Reported by: sejo Owned by: jacob
Component: Database layer (models, ORM) Version: 1.1
Severity: Normal Keywords: model, docstrings, attributes
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

When using attribute docstrings in my models they will never be picked up by doctools as the attributes disappear top level from the model.
This makes me to keep separate documentation and code for djagios.

Change History (8)

comment:1 Changed 6 years ago by sejo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 6 years ago by jacob

  • Owner changed from nobody to jacob
  • Status changed from new to assigned

comment:3 Changed 6 years ago by jacob

  • Triage Stage changed from Unreviewed to Accepted

comment:4 Changed 6 years ago by jacob

This is actually because ModelClass.field raises AttributeError from the descriptor. I've been wanting to stop that, anyway -- it ought to just return the Field object.

comment:5 Changed 4 years ago by julien

  • Severity set to Normal
  • Type set to Bug

comment:6 Changed 3 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:7 Changed 3 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

comment:8 Changed 2 years ago by aaugustin

  • Component changed from Core (Other) to Database layer (models, ORM)
Note: See TracTickets for help on using tickets.
Back to Top