Skip to content

Conversation

@harshil21
Copy link
Member

Enforces correct version in examples so people don't get confused.

@harshil21 harshil21 added the ⚙️ examples affected functionality: examples label May 15, 2022
@harshil21 harshil21 added this to the v20.0 milestone May 15, 2022
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :)

Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

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

  • this doesn't address the problem with ContextTypes.DEFAULT_TYPE - for that we have to check that we have __version_info__ > (20, 0, 0, 'alpha', 0) if __version_info__ is available
  • I think it would be good to explicitly tell the user which version they are using - something along the lines f'You are using version {__version__}'
  • Can we add a header to the examples readme along the lines "The examples in the directory are subject to changes and may not work on the PTB version that you are using. You can find the examples compatible with a specific ptb version at https://…/tree/<vX.Y>/examples"?

Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

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

With version-checking in place, I'd be okay with simply removing the example-warning workflow. One thing less to worry about while developing.

Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

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

I'll merge once the tests are done :)

@Bibo-Joshi Bibo-Joshi merged commit 3013870 into master May 15, 2022
@Bibo-Joshi Bibo-Joshi deleted the enforce-v20 branch May 15, 2022 12:08
@github-actions github-actions bot locked and limited conversation to collaborators May 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

⚙️ examples affected functionality: examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants