Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Deprecate doc_filter in favor of filters with a
doc.
prefix.Motivation and Context
Simplifies the API and reduces duplication. The new combined queries are more general and will more naturally support encoding via URI, see #189.
I made a judgment call based on known usage patterns as to when different things will be deprecated. All
doc_filter
arguments to methods likefind_jobs
are quite old and I know they are used, so preserving them until a 3.0 release makes sense (see also the discussion on glotzerlab/signac-docs#115). I know very few users of thegroupbydoc
method, so I chose to deprecate that in 2.0.Types of Changes
1The change breaks (or has the potential to break) existing functionality.
Checklist:
If necessary: