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

Tools for marking things unsafe for general use #2326

Merged
merged 10 commits into from May 15, 2019
Merged

Tools for marking things unsafe for general use #2326

merged 10 commits into from May 15, 2019

Conversation

@mikeshardmind
Copy link
Contributor

@mikeshardmind mikeshardmind commented Dec 10, 2018

Type

  • Bugfix
  • Enhancement
  • New feature

Description of the changes

Tangentially related to #2324.

This adds some quick tools for marking things as unsafe for general use. It does not block their usage but will raise some runtime warnings if they are used. These warning can be suppressed in known safe contexts with warnings.catch_warnings

Michael H added 2 commits Dec 11, 2018
Actually, make the two do something different 
instead of getting distracted writing different docs for both based on intended usage.
@Tobotimus
Copy link
Member

@Tobotimus Tobotimus commented Jan 28, 2019

This looks good at first glance, but I think the safety module belongs in utils. It doesn't have to be documented for 3rd party developers, but I see it more as a utility than part of core functionality.

Loading

@mikeshardmind
Copy link
Contributor Author

@mikeshardmind mikeshardmind commented Jan 30, 2019

I've gone ahead and moved it to redbot.core.utils.safety I've intentionally not added anything to RTD about this.

Loading

@mikeshardmind mikeshardmind requested a review from palmtree5 as a code owner May 14, 2019
@tekulvw tekulvw merged commit 9a243a1 into Cog-Creators:V3/develop May 15, 2019
1 check passed
Loading
@mikeshardmind mikeshardmind deleted the unsafe-usage-warnings branch Dec 26, 2019
@jack1142 jack1142 added this to the 3.1.0 milestone Nov 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants