Skip to content
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.

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

chore: cleanup documentation issues #1599

Merged
merged 5 commits into from
Sep 22, 2022

Conversation

baronkobama
Copy link
Contributor

@baronkobama baronkobama commented Aug 27, 2022

Summary

This PR cleans up issues with the current master branch documentation. Most of these issues stemmed from #1476 (my bad lol), but a few are newly discovered/created issues.

A couple issues are yet to be solved and I'd like to get that done in this PR. These are:

I'm really not sure how to handle any of the above, any contributions are welcomed. PR will (probably) remain in draft status until the above reach some sort of solution.

Information

  • 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, examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.

@JustaSqu1d
Copy link
Member

The ForumChannel reference's attribute and method table are currently duplicated (I have absolutely zero clue why, please help me).

It could be that there are two ForumChannels which messed up Sphinx documentation.

image

@baronkobama
Copy link
Contributor Author

It could be that there are two ForumChannels which messed up Sphinx documentation.

Good catch, not sure how that happened, but it definitely looks to be the source of the problem. Should be fixed in latest commit.

@baronkobama baronkobama marked this pull request as ready for review September 18, 2022 01:15
@baronkobama
Copy link
Contributor Author

Marking this PR as ready for review. The two remaining issues listed in the summary may or may not be addressed with this PR since I don't want this PR going stale.

@Lulalaby Lulalaby enabled auto-merge (squash) September 22, 2022 00:08
@Lulalaby Lulalaby requested a review from Dorukyum September 22, 2022 00:09
@Lulalaby Lulalaby merged commit 915f9a5 into Pycord-Development:master Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants