Merged
Conversation
- Fix misc/misc.py: Convert single-quoted string to proper docstring - Add class docstring to quotesdb/quotedb.py - Add class docstring to empty_voices/api.py - Add parameter documentation to empty_voices helper methods Agent-Logs-Url: https://github.com/psykzz/cogs/sessions/e409ea9f-6a28-4b48-9a23-441927ba377c Co-authored-by: psykzz <1134201+psykzz@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several cogs had missing or malformed docstrings, reducing code discoverability and breaking Red-bot's help command generation.
Changes
Fixed incorrect docstring format:
misc/misc.py: Converted single-quoted string to proper triple-quoted docstringAdded class-level docstrings:
quotesdb/quotedb.py: Added comprehensive cog descriptionempty_voices/api.py: Added cog description explaining automatic voice channel managementAdded NumPy-style parameter documentation:
empty_voices/api.py: Added Parameters sections to 4 helper methods (cleanup_temp_channels_config,try_delete_channel,validate_category,try_rename_channel)Notes
Modal/View classes in
party/party.py, helper methods insecret_santa/secret_santa.py, and helper functions inalbion_ava/ava.pyalready have proper docstrings.