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

docs: added difference between get_ commands and fetch_ commands in FAQ #2123

Closed
wants to merge 19 commits into from
Closed

Conversation

Blue-Robin-Taken
Copy link
Contributor

Added the difference between get_ commands and fetch_ commands

Summary

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.
  • I have updated the changelog to include these changes.

Added the difference between get_ commands and fetch_ commands


Signed-off-by: Blue-Robin-Taken <[email protected]>
@Blue-Robin-Taken Blue-Robin-Taken changed the title Docs: added difference between get_ commands and fetch_ commands in FAQ docs: added difference between get_ commands and fetch_ commands in FAQ Jun 14, 2023
docs/faq.rst Outdated Show resolved Hide resolved
Signed-off-by: Blue-Robin-Taken <[email protected]>
Lulalaby
Lulalaby previously approved these changes Jun 26, 2023
@Lulalaby Lulalaby enabled auto-merge (squash) June 26, 2023 05:42
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
Co-authored-by: JustaSqu1d <[email protected]>
Signed-off-by: Blue-Robin-Taken <[email protected]>
auto-merge was automatically disabled July 9, 2023 04:31

Head branch was pushed to by a user without write access

Copy link
Member

@JustaSqu1d JustaSqu1d 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 using a simpler example like bot.fetch_user vs bot.get_user would be easier to understand.

My previous review still applies.

@Lulalaby
Copy link
Member

I think this change leads to nowhere.
I'm still having the opinion that it's obvious.
We shouldn't deal with user stupidness.

@JustaSqu1d
Copy link
Member

I think this change leads to nowhere. I'm still having the opinion that it's obvious. We shouldn't deal with user stupidness.

Saying that you need members intent to do this in another method instead of the function itself, for example, is anything, but obvious.

@Lulalaby
Copy link
Member

Then please create a solid pull request yourself with a correct faq about it or better document it in the docstring

@Blue-Robin-Taken
Copy link
Contributor Author

Blue-Robin-Taken commented Sep 14, 2023

@Lulalaby What exactly do you want?

We shouldn't deal with user stupidness.

What would be a "solid" PR, and can't I edit and fix the PR here?

@Lulalaby
Copy link
Member

Lulalaby commented Sep 14, 2023

"user stupidness" wasn't meant as in your pr.
I meant it as in we shouldn't need to documents everything into FAQs.

@JustaSqu1d JustaSqu1d added the documentation Improvements or additions to documentation label Sep 14, 2023
Copy link
Member

@JustaSqu1d JustaSqu1d 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 using a simpler example like bot.fetch_user vs bot.get_user would be easier to understand.

My previous review still applies.

You can't just re-request a review without acknowledging my previous one.

@plun1331
Copy link
Member

my thoughts on this: i personally haven't seen this question frequently asked

@Lulalaby
Copy link
Member

Yeah exactly that and that's why I've closed it in the first place. But squid reopened it

@Blue-Robin-Taken
Copy link
Contributor Author

I think using a simpler example like bot.fetch_user vs bot.get_user would be easier to understand.

My previous review still applies.

You can't just re-request a review without acknowledging my previous one.

I thought I did but I don't have much github experience... Sorry about that. I'll try to fix it

@Blue-Robin-Taken
Copy link
Contributor Author

my thoughts on this: i personally haven't seen this question frequently asked

Although it's not frequently asked, it's gotta be listed somewhere when it is asked.
Where else should it be listed then? @plun1331

Separated the example into two examples

Signed-off-by: Blue-Robin-Taken <[email protected]>
@Lulalaby
Copy link
Member

simple: no where

Signed-off-by: Blue-Robin-Taken <[email protected]>
@plun1331
Copy link
Member

my thoughts on this: i personally haven't seen this question frequently asked

Although it's not frequently asked, it's gotta be listed somewhere when it is asked.
Where else should it be listed then? @plun1331

In the entire time I've been with pycord I've only observed it asked 3-5 times, and the answer is fairly simple to explain each time: get_x gets from cache, fetch_x fetches from discord

If we had to make an entry for every question asked about the library, this FAQ page would be extremely long

@Lulalaby
Copy link
Member

And so I'm closing it.

@Lulalaby Lulalaby closed this Sep 15, 2023
@Pycord-Development Pycord-Development locked as resolved and limited conversation to collaborators Sep 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation on hold
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants