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.

Sign up for GitHub

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

Jump to bottom

Document prefix preservation #4085

Merged
merged 6 commits into from
Aug 3, 2020
Merged

Document prefix preservation #4085

merged 6 commits into from
Aug 3, 2020

Conversation

mikeshardmind
Copy link
Contributor

Description of the changes

Reserves a prefix so that things like #4043 will not be a breaking addition in the future.

@Jackenmen Jackenmen added this to the 3.4.0 milestone Jul 18, 2020
@Jackenmen Jackenmen added Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Release Blocker This needs handling prior to the next non-hotfix release. labels Jul 18, 2020
@Jackenmen Jackenmen added the Breaking Change Will potentially break some cogs. label Jul 20, 2020
@Kowlin Kowlin mentioned this pull request Jul 20, 2020
Closed
@Jackenmen Jackenmen self-assigned this Jul 20, 2020
@Jackenmen
Copy link
Member

Considering that you said that #4045 might also allow to get/delete data on module-level (as additional, non-standard way) we need to at least expand this preservation to cog packages.

I partially want to say that we should expand this to everything, as in make it generic to all subclassable classes not just Cog and Command (+ what's said above), but to be fair it seems like unnecessary future-proofing, considering there's nothing else in Red that's meant to be subclassable (Help Formatter API is one more thing that is based on subclassing but that one is gonna be provisional first anyway) and therefore realistically supported by guarantees.

@mikeshardmind
Copy link
Contributor Author

Help Formatter is also reasonably supported by guarantees in that changing that one after provisional status would definitely need to be breaking either way since it's just a container class for methods with an abc that defines what's currently needed to function.

Jackenmen
Jackenmen approved these changes Jul 23, 2020
View reviewed changes
Copy link
Member

@Jackenmen Jackenmen left a comment

Choose a reason for hiding this comment

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

Looks good to me, this PR is blocked until Red 3.4

@Jackenmen Jackenmen added Blocked QA: Passed Used by few QA members. Has been approved by the assigned QA member(s). labels Jul 23, 2020
@Jackenmen Jackenmen merged commit c5a553a into Cog-Creators:V3/develop Aug 3, 2020
@Cog-CreatorsBot Cog-CreatorsBot added the Changelog Entry: Pending Changelog entry for this PR hasn't been added by repo maintainers yet. label Aug 3, 2020
@Jackenmen Jackenmen added Changelog Entry: Added Changelog entry for this PR has already been added to changelog PR. and removed Blocked Changelog Entry: Pending Changelog entry for this PR hasn't been added by repo maintainers yet. labels Aug 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jackenmen Jackenmen Jackenmen approved these changes

@palmtree5 palmtree5 Awaiting requested review from palmtree5

@tekulvw tekulvw Awaiting requested review from tekulvw

Assignees

@Jackenmen Jackenmen

Labels
Breaking Change Will potentially break some cogs. Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Changelog Entry: Added Changelog entry for this PR has already been added to changelog PR. QA: Passed Used by few QA members. Has been approved by the assigned QA member(s). Release Blocker This needs handling prior to the next non-hotfix release.
Projects
None yet
Milestone
3.4.0
Development

Successfully merging this pull request may close these issues.
3 participants
@mikeshardmind @Jackenmen @Cog-CreatorsBot