Skip to content

Conversation

@mAxYoLo01
Copy link
Contributor

About

This PR's goal is to massively revamp the docs to a more readable version.

In this PR is included:

  • Rethink the general layout of the docs to make them more user-friendly, and highlight the important part
  • Remove certain "private" files from being generated in docs (cache, error, gateway, ...) as they should not be public
  • Hide private methods & functions from the docs
  • Fix multiple docs generation warnings & errors
  • Remove all ? from docstrings
  • Combining :param: and :type: into a single line in docstrings

Checklist

  • The pre-commit code linter has been run over all edited files to ensure the code is linted.
  • I've ensured the change(s) work on 3.8.6 and higher.

I've made this pull request: (check all that apply)

  • For the documentation
  • To add a new feature
  • As a general enhancement
  • As a refactor of the library/the library's code
  • To fix an existing bug
  • To resolve #ISSUENUMBER

This is:

  • A breaking change

Copy link
Contributor

@EepyElvyra EepyElvyra left a comment

Choose a reason for hiding this comment

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

target branch. Also why the removal of error docs?

@mAxYoLo01
Copy link
Contributor Author

Here is the new layout of the docs:
image
image

@mAxYoLo01
Copy link
Contributor Author

target branch. Also why the removal of error docs?

I feel like since this is such a massive update, it belongs in unstable. Not only docs have been changed. Also, the docs branch is quite behind.

The error page had nothing important in it, kind of like the cache one, nothing that a random person needs to see.

@EepyElvyra
Copy link
Contributor

target branch. Also why the removal of error docs?

I feel like since this is such a massive update, it belongs in unstable. Not only docs have been changed. Also, the docs branch is quite behind.

The error page had nothing important in it, kind of like the cache one, nothing that a random person needs to see.

Alright, that is fair

and yeah I didn't see the code changes tbf

@mAxYoLo01
Copy link
Contributor Author

I'm going to have to regenerate all the locale docs too with all the modifications, should I do it here or another PR?

@mAxYoLo01 mAxYoLo01 requested a review from EepyElvyra October 11, 2022 15:16
@EepyElvyra EepyElvyra added the on hold This issue/PR is on hold pending higher priority issues/PRs label Oct 14, 2022
@mAxYoLo01 mAxYoLo01 marked this pull request as draft October 15, 2022 13:34
@Catalyst4222 Catalyst4222 linked an issue Oct 31, 2022 that may be closed by this pull request
1 task
@mAxYoLo01 mAxYoLo01 marked this pull request as ready for review October 31, 2022 13:19
@EepyElvyra EepyElvyra removed the on hold This issue/PR is on hold pending higher priority issues/PRs label Oct 31, 2022
Copy link
Contributor

@EepyElvyra EepyElvyra left a comment

Choose a reason for hiding this comment

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

Has http been removed from index and searching?

@mAxYoLo01
Copy link
Contributor Author

Has http been removed from index and searching?

Yes, as these methods should not be used by developers except if they have very good reasons to, which in this case I would guess they would check the source code at this point.

@mAxYoLo01 mAxYoLo01 closed this Oct 31, 2022
@mAxYoLo01 mAxYoLo01 reopened this Oct 31, 2022
@EepyElvyra
Copy link
Contributor

Has http been removed from index and searching?

Yes, as these methods should not be used by developers except if they have very good reasons to, which in this case I would guess they would check the source code at this point.

Yeah I'm pro removing, sick of seeing "why is interactions.api.http.guild.GuildRequest.get_member(id) not working" xD

@Damego Damego added the documentation Improvements or additions to documentation label Nov 3, 2022
Copy link
Contributor

@EepyElvyra EepyElvyra left a comment

Choose a reason for hiding this comment

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

I think this is fine and I don't want to make you a hell conflict when I make another refactor, or the other way around

@EepyElvyra EepyElvyra merged commit bd10d8a into interactions-py:unstable Nov 9, 2022
@mAxYoLo01 mAxYoLo01 deleted the docstring-update branch November 10, 2022 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQUEST] Update function parameters

3 participants