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 current directives syntax. #792

Merged
merged 3 commits into from
Jan 10, 2024
Merged

Conversation

b-butler
Copy link
Member

Description

Adds deprecation warnings to the entry points for directives.

Motivation and Context

In order to make the new directives style possible, we need to remove the current way we handle directives (see #785).

Checklist:

@b-butler b-butler requested review from a team as code owners December 15, 2023 19:58
@b-butler b-butler requested review from bdice and jennyfothergill and removed request for a team December 15, 2023 19:58
Copy link

codecov bot commented Dec 15, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (393fb73) 69.54% compared to head (ade15ca) 69.53%.

Files Patch % Lines
flow/project.py 60.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #792      +/-   ##
==========================================
- Coverage   69.54%   69.53%   -0.02%     
==========================================
  Files          48       48              
  Lines        4417     4422       +5     
  Branches     1069     1071       +2     
==========================================
+ Hits         3072     3075       +3     
- Misses       1138     1139       +1     
- Partials      207      208       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

flow/project.py Outdated
if directives is not None:
warnings.warn(
"The current directives are deprecated as of flow 0.27. When updating flow "
"please look at the documentation for the new style.",
Copy link
Member

Choose a reason for hiding this comment

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

It would be nice to have a link to where this documentation will be or at least keep it updated as this changes

@bdice bdice changed the title Depreciate current directives syntax. Deprecate current directives syntax. Jan 9, 2024
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.

A couple suggestions, otherwise LGTM.

flow/project.py Outdated Show resolved Hide resolved
flow/project.py Outdated Show resolved Hide resolved
@b-butler b-butler enabled auto-merge (squash) January 10, 2024 00:14
@b-butler b-butler merged commit 5a53d17 into main Jan 10, 2024
9 of 11 checks passed
@b-butler b-butler deleted the misc/deprecate-directives branch January 10, 2024 01:06
@b-butler b-butler added this to the v0.27.0 milestone Jan 15, 2024
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.

3 participants