Skip to content

Commit

Permalink
Added some registration notes to start the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Corey Oordt committed Feb 1, 2010
1 parent 59cf711 commit 0ec1fa7
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/registering_models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
==================
Registering Models
==================




You can register models with the

import categories
categories.register_fk(MyModel)

or

import categories
categories.register_m2m(MyModel)

If you want more than one field on a model you have to have some extra arguments

import categories
categories.register_fk(MyModel, 'primary_category')
categories.register_fk(MyModel, 'secondary_category', {'related_name':'mymodel_sec_set'})

The ``extra_args`` allows you to specify the related_name of one of the fields so it doesn't clash.

0 comments on commit 0ec1fa7

Please sign in to comment.