signac icon indicating copy to clipboard operation
signac copied to clipboard

Remove --doc-filter from CLI

Open bdice opened this issue 3 years ago • 4 comments

Feature description

From #586 conversation: https://github.com/glotzerlab/signac/pull/586#issuecomment-904777526

Yes, I think --doc-filter should be removed in all cases. The signac-flow PR is less urgent since it only needs to go in before whichever flow version is the first to support signac 2.0, but adding the warning for find --doc-filter in this PR makes sense.

I decided to tackle this in a follow-up PR rather than extend #586.

Proposed solution

signac find --doc-filter ... should be deprecated in 2.0 and removed in 3.0. A warning should be shown in signac 2.0.

--doc-filter should be deprecated and removed from signac-flow's CLI (e.g., project.py status --doc-filter ...).

bdice avatar Aug 25 '21 17:08 bdice

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 30 '21 06:10 stale[bot]

I can take this up @bdice or we can add a good first issue label on this for others to try?

kidrahahjo avatar Feb 16 '22 18:02 kidrahahjo

I think this would be a good first issue to let someone else take on. IMO there are more complicated things that would benefit more from your expertise :)

vyasr avatar Feb 16 '22 22:02 vyasr

Based on recent discussions, this issue must be resolved for signac 2.0.

vyasr avatar May 02 '22 05:05 vyasr

Resolved in #795.

vyasr avatar Sep 18 '22 15:09 vyasr