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

Add explicit mention of word 'provisional' for version guarantee exclusions #6311

Merged
merged 1 commit into from
Mar 18, 2024
Merged

Add explicit mention of word 'provisional' for version guarantee exclusions #6311

merged 1 commit into from
Mar 18, 2024

Conversation

Jackenmen
Copy link
Member

Description of the changes

This PR rearranges the Developer Guarantees section to put the information about exclusions in a separate section (which can be referred to from other places) and adds a note that the word "provisional" may be used to indicate that an API is excluded. This section is now referred to in all places where we explicitly exclude an API from guarantees.

Have the changes in this PR been tested?

Yes

@Jackenmen Jackenmen requested a review from Flame442 March 18, 2024 00:09
@github-actions github-actions bot added Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Category: Core - API - Commands Package This is related to the `redbot.core.commands` package or `redbot.core.checks` module. Category: Core - Help This is related to our help command and/or HelpFormatter API. Category: Core - RPC/ZMQ Related to provided (provisional) API for implementing RPC in cogs Category: Docs - Changelogs This is related to version changelogs. Category: Core - Bot Class This is related to the `redbot.core.bot.Red` class. labels Mar 18, 2024
@Flame442 Flame442 added this to the 3.5.6 milestone Mar 18, 2024
@Flame442 Flame442 self-assigned this Mar 18, 2024
@Flame442 Flame442 added the Type: Enhancement Something meant to enhance existing Red features. label Mar 18, 2024
@Flame442 Flame442 merged commit 0c83fcd into Cog-Creators:V3/develop Mar 18, 2024
18 checks passed
@red-githubbot red-githubbot bot added the Changelog Entry: Pending Changelog entry for this PR hasn't been added by repo maintainers yet. label Mar 18, 2024
@Jackenmen Jackenmen added Changelog Entry: Added Changelog entry for this PR has already been added to changelog PR. and removed Changelog Entry: Pending Changelog entry for this PR hasn't been added by repo maintainers yet. labels Mar 22, 2024
Dav-Git pushed a commit to Dav-Git/Red-DiscordBot that referenced this pull request Sep 8, 2024
@Jackenmen @Dav-Git
Add explicit mention of word 'provisional' for version guarantee excl…
6f18f68 
…usions (Cog-Creators#6311)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Flame442 Flame442 Flame442 approved these changes

Assignees

@Flame442 Flame442

Labels
Category: Core - API - Commands Package This is related to the `redbot.core.commands` package or `redbot.core.checks` module. Category: Core - Bot Class This is related to the `redbot.core.bot.Red` class. Category: Core - Help This is related to our help command and/or HelpFormatter API. Category: Core - RPC/ZMQ Related to provided (provisional) API for implementing RPC in cogs Category: Docs - Changelogs This is related to version changelogs. 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. Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Milestone
3.5.6
Development

Successfully merging this pull request may close these issues.
2 participants
@Jackenmen @Flame442