Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
tandemdude committed Jun 14, 2021
1 parent 73aa2eb commit 99c6555
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions lightbulb/converters.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Lightbulb. If not, see <https://www.gnu.org/licenses/>.
"""
.. _converters:
Lightbulb will attempt to convert command arguments using the type or function specified by the type
hints of each argument. By default, any types that can be converted to from a string are supported - eg int or
float.
Expand Down
2 changes: 1 addition & 1 deletion lightbulb/help.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def get_command_signature(command: commands.Command) -> str:
"""
Get the command signature (usage) for a command or command group.
The signature is returned in the format:
``<command name> <required arg> [optional arg] (consume rest arg...)``
``<command name> <required arg> [optional arg]``
Args:
command (:obj:`~.commands.Command`): The command or group to get the signature for.
Expand Down

0 comments on commit 99c6555

Please sign in to comment.