MCPcopy Index your code
hub / github.com/PySimpleGUI/PySimpleGUI / _github_issue_help

Function _github_issue_help

DemoPrograms/Demo_Post_An_Issue.py:175–244  ·  view source on GitHub ↗
()

Source from the content-addressed store, hash-verified

173
174
175def _github_issue_help():
176 heading_font = '_ 12 bold underline'
177 text_font = '_ 10'
178
179 def HelpText(text):
180 return sg.Text(text, size=(80, None), font=text_font)
181
182 help_why = \
183""" Let's start with a review of the Goals of the PySimpleGUI project
1841. To have fun
1852. For you to be successful
186
187This form is as important as the documentation and the demo programs to meeting those goals.
188
189The GitHub Issue GUI is here to help you more easily log issues on the PySimpleGUI GitHub Repo. """
190
191 help_goals = \
192""" The goals of using GitHub Issues for PySimpleGUI question, problems and suggestions are:
193* Give you direct access to engineers with the most knowledge of PySimpleGUI
194* Answer your questions in the most precise and correct way possible
195* Provide the highest quality solutions possible
196* Give you a checklist of things to try that may solve the problem
197* A single, searchable database of known problems and their workarounds
198* Provide a place for the PySimpleGUI project to directly provide support to users
199* A list of requested enhancements
200* An easy to use interface to post code and images
201* A way to track the status and have converstaions about issues
202* Enable multiple people to help users """
203
204 help_explain = \
205""" GitHub does not provide a "form" that normal bug-tracking-databases provide. As a result, a form was created specifically for the PySimpleGUI project.
206
207The most obvious questions about this form are
208* Why is there a form? Other projects don't have one?
209* My question is an easy one, why does it still need a form?
210
211The answer is:
212I want you to get your question answered with the highest quality answer possible as quickly as possible.
213
214The longer answer - For quite a while there was no form. It resulted the same back and forth, multiple questions comversation. "What version are you running?" "What OS are you using?" These waste precious time.
215
216If asking nicely helps... PLEASE ... please fill out the form.
217
218I can assume you that this form is not here to punish you. It doesn't exist to make you angry and frustrated. It's not here for any purpose than to try and get you support and make PySimpleGUI better. """
219
220 help_experience = \
221""" Not many Bug-tracking systems ask about you as a user. Your experience in programming, programming in Python and programming a GUI are asked to provide you with the best possible answer. Here's why it's helpful. You're a human being, with a past, and a some amount of experience. Being able to taylor the reply to your issue in a way that fits you and your experience will result in a reply that's efficient and clear. It's not something normally done but perhaps it should be. It's meant to provide you with a personal response.
222
223If you've been programming for a month, the person answering your question can answer your question in a way that's understandable to you. Similarly, if you've been programming for 20 years and have used multiple Python GUI frameworks, then you are unlikely to need as much explanation. You'll also have a richer GUI vocabularly. It's meant to try and give you a peronally crafted response that's on your wavelength. Fun & success... Remember those are our shared goals"""
224
225 help_steps = \
226""" The steps to log an issue are:
2271. Fill in the form
2282. Click Post Issue """
229 layout = [
230 [sg.T('Goals', font=heading_font, pad=(0,0))],
231 [HelpText(help_goals)],
232 [sg.T('Why?', font=heading_font, pad=(0,0))],

Callers 1

main_open_github_issueFunction · 0.85

Calls 2

HelpTextFunction · 0.85
readMethod · 0.45

Tested by

no test coverage detected