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

Remove 'Meta.together' option #791

Merged
merged 1 commit into from
Oct 20, 2017

Conversation

rpkilby
Copy link
Collaborator

@rpkilby rpkilby commented Oct 18, 2017

Especially given that the #784 was rejected, I'm somewhat inclined to remove the Meta.together option, and replace it with a Form.clean example in the docs (which would also cover exclusive filter handling).

TODO:

  • Add deprecation
  • Add docs example for Form.clean together/exclusive handling

@carltongibson
Copy link
Owner

hehe. You're Psychic.

Yes. I'd take this. 😃

Aside: the general thing I'm aiming for is less magic rather than more. I want to guide people towards overriding the form class etc. There is already "one correct way to do things". It just needs highlighting.

My Autumn Project™ is the long-awaited reworking of the documentation, to this effect.

@carltongibson
Copy link
Owner

If you wanted to tick off those TODOs now, I'd take this for 1.1...?

(no stress if not, there's no rush for it.)

@rpkilby
Copy link
Collaborator Author

rpkilby commented Oct 18, 2017

Hmmmm. how about a simple deprecation warning for the together option? Give me ~10 minutes

@rpkilby
Copy link
Collaborator Author

rpkilby commented Oct 18, 2017

ie, add a deprecation warning for 1.1, remove in 2.0

@carltongibson
Copy link
Owner

Yep. That would be fine. (That's sort of what I meant really — best not to just break it... 🙃)

@codecov-io
Copy link

codecov-io commented Oct 19, 2017

Codecov Report

Merging #791 into develop will decrease coverage by 0.12%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #791      +/-   ##
===========================================
- Coverage    97.54%   97.42%   -0.13%     
===========================================
  Files           15       15              
  Lines         1222     1202      -20     
===========================================
- Hits          1192     1171      -21     
- Misses          30       31       +1
Impacted Files Coverage Δ
django_filters/filterset.py 100% <100%> (ø) ⬆️
django_filters/utils.py 98.21% <0%> (-0.9%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5691fee...01a1f67. Read the comment docs.

@rpkilby
Copy link
Collaborator Author

rpkilby commented Oct 19, 2017

This is basically ready to go, but needs to be rebased off of #795

@carltongibson carltongibson added this to the Version 2.0 milestone Oct 19, 2017
@carltongibson carltongibson merged commit 7e4530a into carltongibson:develop Oct 20, 2017
@rpkilby rpkilby deleted the remove-together-option branch October 20, 2017 13:38
carltongibson pushed a commit that referenced this pull request Oct 24, 2017
carltongibson pushed a commit that referenced this pull request Oct 24, 2017
@rpkilby rpkilby changed the title [2.x proposal] Remove 'Meta.together' option Remove 'Meta.together' option Jan 27, 2018
@kviktor
Copy link

kviktor commented Aug 18, 2022

An example will be provided in a "recipes" section in future docs.

is it in the docs somewhere? I couldn't find anything related to this.

#1167 is something similar but doesn't seem like it's going to be merged

@carltongibson
Copy link
Owner

Ah, my long standing todo, yes.

Did you see the last comment on the linked PR?

https://gitlab.com/-/snippets/2237049

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

Successfully merging this pull request may close these issues.

None yet

4 participants