Skip to content

Conversation

@CoderJoshDK
Copy link
Contributor

@CoderJoshDK CoderJoshDK commented Oct 21, 2025

Summary

Closes #1461
Closes #1454

Warning

This PR is technically a breaking change

The docs extra should never be consumed by end users. However, technically, this would break anyone who did do that. Don't know why they would. But it could be the case.

  • Moved docs group into dev dependency (update nox & readthedocs)
  • Used an extra in the extra (aiohttp[speedups])
  • Simplified doc group by including changelog group

Checklist

  • If code changes were made, then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running uv run nox -s lint
    • I have type-checked the code by running uv run nox -s pyright
  • This PR fixes an issue
  • This PR adds something new (e.g. new method or parameters)
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

@read-the-docs-community
Copy link

read-the-docs-community bot commented Oct 21, 2025

Documentation build overview

📚 disnake | 🛠️ Build #30026616 | 📁 Comparing a71c0bd against latest (7c3b4f0)


🔍 Preview build

Show files changed (48 files in total): 📝 48 modified | ➕ 0 added | ➖ 0 deleted
File Status
index.html 📝 modified
whats_new.html 📝 modified
api/abc.html 📝 modified
api/activities.html 📝 modified
api/app_commands.html 📝 modified
api/app_info.html 📝 modified
api/audit_logs.html 📝 modified
api/automod.html 📝 modified
api/channels.html 📝 modified
api/clients.html 📝 modified
api/components.html 📝 modified
api/emoji.html 📝 modified
api/entitlements.html 📝 modified
api/events.html 📝 modified
api/exceptions.html 📝 modified
api/guild_scheduled_events.html 📝 modified
api/guilds.html 📝 modified
api/integrations.html 📝 modified
api/interactions.html 📝 modified
api/invites.html 📝 modified
api/localization.html 📝 modified
api/members.html 📝 modified
api/messages.html 📝 modified
api/misc.html 📝 modified
api/permissions.html 📝 modified
api/roles.html 📝 modified
api/skus.html 📝 modified
api/soundboard.html 📝 modified
api/stage_instances.html 📝 modified
api/stickers.html 📝 modified
api/subscriptions.html 📝 modified
api/ui.html 📝 modified
api/users.html 📝 modified
api/utilities.html 📝 modified
api/voice.html 📝 modified
api/webhooks.html 📝 modified
api/widgets.html 📝 modified
ext/tasks/index.html 📝 modified
ext/commands/api/app_commands.html 📝 modified
ext/commands/api/bots.html 📝 modified
ext/commands/api/checks.html 📝 modified
ext/commands/api/cogs.html 📝 modified
ext/commands/api/context.html 📝 modified
ext/commands/api/converters.html 📝 modified
ext/commands/api/exceptions.html 📝 modified
ext/commands/api/help_commands.html 📝 modified
ext/commands/api/misc.html 📝 modified
ext/commands/api/prefix_commands.html 📝 modified

@CoderJoshDK CoderJoshDK marked this pull request as ready for review October 21, 2025 14:25
@CoderJoshDK CoderJoshDK requested a review from a team as a code owner October 21, 2025 14:25
@shiftinv shiftinv added t: dependencies Addition/update/removal of dependencies t: meta Changes to the project itself (CI, configs, etc.) labels Oct 21, 2025
typing-extensions is explicitly required in root. So it isn't needed in
the dependency group
"pytest-asyncio~=0.24.0",
"looptime~=0.2.0",
"coverage[toml]~=7.10.0",
"typing-extensions>=4.6",
Copy link
Member

Choose a reason for hiding this comment

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

This is in both groups because our tests use features from typing-extensions 4.6 or greater, while the main library only requires typing-extensions 4.1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should you not just bump up the minimum version of typing-extensions, then? I need to go through the changelog a bit more. But it might even be valid to go all the way up to 4.14.0. It would drop support for 3.8. And opens up the ability to consume 3.14 syntax.
That minimum version spec testing would be helpful here for validation... but either way, I see no reason to not raise the minimum. If you expect it to be required anyway for the types of things you do in the tests, it seems reasonable to expect that the end user will also need a compatible version (I should check the tests code though ...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t: dependencies Addition/update/removal of dependencies t: meta Changes to the project itself (CI, configs, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

use aiohttp[speedups] as the speedup dependency rather than directly on aiohttp's speedups Move docs dependency group

3 participants