Skip to content

Document application commands #308

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
Merged
CodeWithSwastik merged 11 commits into from
Oct 29, 2021
Merged

Document application commands #308

CodeWithSwastik merged 11 commits into from
Oct 29, 2021

Conversation

@Dorukyum
Copy link
Member

@Dorukyum Dorukyum commented Oct 23, 2021

Summary

This attempts to document application command types.
Also removes the documentation for ApplicationCommandMixin as it's already subclassed by and docced under Bot.

Checklist

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • 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, typehinting, ...)

@Dorukyum Dorukyum added the status: in progress Work in Progess label Oct 25, 2021
BobDotCom
BobDotCom reviewed Oct 25, 2021
View reviewed changes
@BobDotCom
Copy link
Contributor

BobDotCom commented Oct 25, 2021

These changes style according to rst.

@Dorukyum @BobDotCom
Apply fixes from suggestions
5136a48 
Co-authored-by: BobDotCom <71356958+BobDotCom@users.noreply.github.com>
@Dorukyum
Copy link
Member Author

Dorukyum commented Oct 25, 2021

I totally missed that, it has been fixed now.

@izxxr
Copy link
Contributor

izxxr commented Oct 25, 2021

Aren't the classes actually need to be documented? The docstrings I mean. ?

@Dorukyum
Copy link
Member Author

Dorukyum commented Oct 25, 2021

autoclass should handle that. Reference: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

@izxxr
Copy link
Contributor

izxxr commented Oct 25, 2021

autoclass should handle that. Reference: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

That's not what I meant. I mean the docstrings aren't added in the classes.

@Dorukyum Dorukyum added the documentation Improvements or additions to documentation label Oct 25, 2021
Lulalaby
Lulalaby previously approved these changes Oct 26, 2021
View reviewed changes
@Dorukyum Dorukyum changed the base branch from master to document-app-commands October 29, 2021 08:18
@Dorukyum
Copy link
Member Author

Dorukyum commented Oct 29, 2021

Changed the base to document-app-commands so we can collaborate. I suppose it can be merged now.

Lulalaby
Lulalaby approved these changes Oct 29, 2021
View reviewed changes
Copy link
Member

@Lulalaby Lulalaby left a comment

Choose a reason for hiding this comment

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

LGTM

Attachment can be kept out atm

@CodeWithSwastik CodeWithSwastik enabled auto-merge (squash) October 29, 2021 15:17
@CodeWithSwastik CodeWithSwastik merged commit 85a0455 into Pycord-Development:document-app-commands Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lulalaby Lulalaby Lulalaby approved these changes

@BobDotCom BobDotCom BobDotCom approved these changes

+1 more reviewer

@CodeWithSwastik CodeWithSwastik CodeWithSwastik approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation status: in progress Work in Progess

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Dorukyum @BobDotCom @izxxr @Lulalaby @CodeWithSwastik