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

Deprecate doc_filter parameters. #516

Merged
merged 3 commits into from
Mar 8, 2021
Merged

Deprecate doc_filter parameters. #516

merged 3 commits into from
Mar 8, 2021

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Feb 26, 2021

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 like find_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 the groupbydoc method, so I chose to deprecate that in 2.0.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality.

Checklist:

If necessary:

  • I have updated the API documentation as part of the package doc-strings.
  • I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
  • I have updated the changelog and added all related issue and pull request numbers for future reference (if applicable). See example below.

@vyasr vyasr requested review from a team as code owners February 26, 2021 18:02
@vyasr vyasr requested review from bdice and pepak13 and removed request for a team February 26, 2021 18:02
@codecov
Copy link

codecov bot commented Feb 26, 2021

Codecov Report

Merging #516 (b5f2e87) into master (7795dad) will increase coverage by 0.00%.
The diff coverage is 83.33%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #516   +/-   ##
=======================================
  Coverage   78.16%   78.16%           
=======================================
  Files          65       65           
  Lines        7030     7036    +6     
  Branches     1310     1310           
=======================================
+ Hits         5495     5500    +5     
- Misses       1230     1231    +1     
  Partials      305      305           
Impacted Files Coverage Δ
signac/contrib/project.py 85.06% <83.33%> (-0.02%) ⬇️

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 7795dad...b5f2e87. Read the comment docs.

@vyasr
Copy link
Contributor Author

vyasr commented Mar 7, 2021

@bdice @pepak13 mind taking a look at this?

Copy link
Member

@bdice bdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me.

@vyasr vyasr merged commit 786d75f into master Mar 8, 2021
@vyasr vyasr deleted the deprecation/doc_filter branch March 8, 2021 01:41
@bdice bdice added this to the 1.7.0 milestone Jun 8, 2021
@bdice bdice mentioned this pull request Aug 2, 2021
12 tasks
@cbkerr cbkerr mentioned this pull request Mar 27, 2022
6 tasks
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

2 participants