Skip to content

Sphinx docstring issues #2894

@Lulalaby

Description

@Lulalaby

TODO for another time:

/home/runner/work/pycord/pycord/discord/commands/core.py:docstring of discord.SlashCommand.cog:1: WARNING: duplicate object description of discord.SlashCommand.cog, other instance in api/application_commands, use :no-index: for one of them
/home/runner/work/pycord/pycord/discord/bot.py:docstring of discord.client.Client.get_all_channels:8: WARNING: Literal block ends without a blank line; unexpected unindent. [docutils]
/home/runner/work/pycord/pycord/discord/client.py:docstring of discord.client.Client.get_all_channels:8: WARNING: Literal block ends without a blank line; unexpected unindent. [docutils]
/home/runner/work/pycord/pycord/discord/automod.py:docstring of discord.automod.AutoModTriggerMetadata:72: WARNING: Duplicate explicit target name: "here". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawTypingEvent:45: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawMessageDeleteEvent:37: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawBulkMessageDeleteEvent:37: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawMessageUpdateEvent:40: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawReactionActionEvent:91: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawReactionClearEvent:31: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawReactionClearEmojiEvent:65: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawIntegrationDeleteEvent:33: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawThreadDeleteEvent:45: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawScheduledEventSubscription:43: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawMemberRemoveEvent:29: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawThreadUpdateEvent:43: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawThreadMembersUpdateEvent:33: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawAuditLogEntryEvent:64: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/raw_models.py:docstring of discord.raw_models.RawVoiceChannelStatusUpdateEvent:31: WARNING: Duplicate explicit target name: "gateway". [docutils]
/home/runner/work/pycord/pycord/discord/ext/commands/bot.py:docstring of discord.client.Client.get_all_channels:8: WARNING: Literal block ends without a blank line; unexpected unindent. [docutils]
/home/runner/work/pycord/pycord/discord/ext/commands/core.py:docstring of discord.ext.commands.core.check_any:21: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]

Originally posted by @Lulalaby in #2892 (comment)

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Projects

Status

Todo

Relationships

None yet

Development

No branches or pull requests

Issue actions