Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement in the documentation #81

Open
tvanesse opened this issue May 18, 2017 · 1 comment
Open

Enhancement in the documentation #81

tvanesse opened this issue May 18, 2017 · 1 comment

Comments

@tvanesse
Copy link

I think it's worth mentioning that for old-style classes the order in which we declare the multiple inheritance on the ModelAdmin is important.

More specifically, writing

class MyModelAdmin(admin.ModelAdmin, DjangoObjectActions):
     # your ModelAdmin

won't work because of the depth-first, left-to-right rule whereas

class MyModelAdmin(DjangoObjectActions, admin.ModelAdmin):
     # your ModelAdmin

will work as expected.

So just one sentence in the README might save some time for those trying to use django-object-actions.

By the way thanks a lot for this application, it's really handy.

@crccheck
Copy link
Owner

The class MyModelAdmin(DjangoObjectActions, admin.ModelAdmin): is already in the README. I want to lean towards keeping the README as small as possible:

  1. adding more to the README would increase technical debt
  2. I don't have a documentation site yet, so all the usage is crammed into the README right now
  3. To keep the README smaller, I aim the README at an intermediate or advanced Python developer. I like the idea of adding a disclaimer to that effect to the top of the README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants