search

python-discord / meta

Issue tracker for suggestions and other questions relating to our community
https://pythondiscord.com
30 stars 5 forks source link

Discourage screenshots by those seeking help in chat #148

Open aaronchall opened 3 years ago

aaronchall commented 3 years ago

Discord voice-chat room visitors seeking help frequently post screenshots of their code.

My experience helping people in chat, Stack Overflow, and in real life (Python meetup group office hours, teaching students, etc...) is that getting screenshots instead of copy-pastable code slows the process greatly while I explain that I can't execute their pic, and what to do instead.

It would be great to have something to point them to before they start asking. Here's a part of the revision I am working on in the "Asking Good Questions" article.

# A Good Question

When you're ready to ask a question, here are some helpful suggestions:

* Post a code sample that can be run to illustrate the problem (not a screenshot)
* For lengthy code use [paste.pythondiscord.com](https://paste.pythondiscord.com/)

Additionally, I think I can further clean up the English grammar and style of the document for the benefit of non-native-English speakers and I'm willing to give a bit of my time on it if it would be welcome.

Akarys42 commented 3 years ago

Hey @aaronchall, thanks for your suggestion, transferring this to the meta repo so we can properly discuss this. You said you were working on a revision of the article, do you perhaps have any draft to suggest?

I personally think adding a no-code-picture entry to that article would be a good idea, although I don't know how much reach this article really has.

aaronchall commented 3 years ago

Reach? Not much. As we all know, on the internet, nobody reads anything.

But it's the document we link to from chat that advises on how to ask questions, and it's the document that we should be pointing people at if they seem to need help asking questions.

I don't want to re-imagine the document or change the structure of it, but I see lots of stream-of-thought writing that can really be tightened up, without losing the ideas being communicated.

Since you're asking for a draft, how would you like a pull request? If we do that, then we can get comments line-by-line if we wish. I was told a pull request without an issue would be immediately rejected, otherwise I would have started with that.

Akarys42 commented 3 years ago

Since you're asking for a draft, how would you like a pull request? If we do that, then we can get comments line-by-line if we wish. I was told a pull request without an issue would be immediately rejected, otherwise I would have started with that.

Sure thing! Feel free to open a draft PR

GDWR commented 1 year ago

Hi @aaronchall, is this still being worked on, and is there an active or previous PR that could be linked?

For reference, the mentioned article can be found here