New Users, Read This

New Users, Read This

Postby metulburr » Mon Feb 11, 2013 2:56 am

Subject/Title of post
Please try to use a subject line that desctribes your problem well.
From the subject line alone it should give a good indication of what the problem is, 'Please Help' is not a good subject line, for example.

How to post code
Because Python uses indentation for blocks, it is essential to use code tags when posting code in the forums. Code in code tags makes it easier for us to read, and indented the way you meant it to be.
  1. click post reply or post topic
  2. Above the text area box, there are tag buttons (B, i, u, Code, etc.)
  3. click the code tag "Code" to insert code tags into the text area
    1. You can either click the code tag, and paste your code between the two tags or:
    2. You can copy just your code, and click the code tag, which will wrap your code in code tags
Code: Select all
[code]Put Your Code Here[/code]


"Newly Registered User" restrictions:
  • Your first post will be moderated. The post will not be visable until a moderator approves it. Please do not make duplicate first posts as this will have no effect. You will be taken out of newly registered users and into registered users, and from thereafter you may post freely. Sorry for the inconvenience, as this filters the spam from real posts, and keeps our forum spam free. To quicken the process of getting approved, you can join and notify moderators on our IRC channel of your newly post.
  • You are not allowed to have a signature
Before you post questions read the Tutorials, Programming Ideas, Free Python Resources, and Python IDE's. You can stop by and say hello in New Users Introduce Yourself. If you do not find a tutorial suiting your needs. You may request one made. If there is a reference/tutorial missing from Free Pyhon Resources, you may suggest to add it there. If you are not sure about which Python version to use, check here.

How to ask good questions
Below are some general guidelines for this site, and they often apply to other programming forums, but How to ask good questions in general is a well-explored topic. It is seriously recommended that you read this link.
Describe the goal, not the step

If you are trying to find out how to do something (as opposed to reporting a bug), begin by describing the goal. Only then describe the particular step towards it that you are blocked on.

Often, people who need technical help have a high-level goal in mind and get stuck on what they think is one particular path towards the goal. They come for help with the step, but don't realize that the path is wrong. It can take substantial effort to get past this.

Stupid: How do I get the color-picker on the FooDraw program to take a hexadecimal RGB value?

Smart: I'm trying to replace the color table on an image with values of my choosing. Right now the only way I can see to do this is by editing each table slot, but I can't get FooDraw's color picker to take a hexadecimal RGB value.

The second version of the question is smart. It allows an answer that suggests a tool better suited to the task.


Homework
Naturally, we understand that some students will use this forum to get assistance with their homework, and as a community, we are happy to help. We are not, however, going to do your homework for you. Read the What to include in a post section! This should be taken extra seriously for students, to prevent yourself from being perceived as academically dishonest and reported to your school based on your IP address.

If you are asking for help with homework, we ask that you be honest and admit that it's a homework related question. Show what you've done on your own, and post the code that is causing you problems. Post the exact assignment you've been given, so we know what we're working with.

If you're answering a question that seems like it might be homework, please quote the original post (unless a moderator has locked the post), so that the original question will not be lost if someone edits their old post.

What to include in a post (read this! seriously!)
  • If you're asking a question about code, don't make a post without your own code. Post any code (even if one line) in code tags to help differentiate code from text.
  • Always add the entire Traceback that you get. For example, the code.
    Code: Select all
    1 + '2'

    when put into a Python shell will give you the following traceback (the error message)
    Code: Select all
    Traceback (most recent call last):
      File "<pyshell#0>", line 1, in <module>
        1 + '2'
    TypeError: unsupported operand type(s) for +: 'int' and 'str'

    don't just post the "TypeError: unsupported operand type(s) for +: 'int' and 'str'" part. Do not attempt to summarize or interpret for our benefit, although you're welcome to do so if you want us to let you know that you have it right.
  • Post as much code as necessary and as little as possible to reproduce your error, as well as instructions for how to run that code (what input it needs, what files need to be present). If "as much code as necessary" is all your code, then so be it, but if you have a thousand line script and you're getting a traceback similar to the above, you could reproduce the error in one line and posting too much makes it very difficult to answer your question. (As a bonus, reducing your code like this often makes it easier for you to figure out the solution on your own!) Also, the less code you post, the more likely you will get a good, fast, correct response.
  • For testing purposes, it often makes things easier for us if you replace a raw_input() call with a hard-coded variable that reproduces your problem. Also include the current output of your program, the desired output, and a short summary of the difference between the two.
  • If your program has a GUI (graphical user interface, such as Tkinter, wx, pyqt, etc.) and your problem is with something other than the GUI programming, you will be more likely to get help if you only the post code that you need help with. Separating program logic from user interface is good practice anyway
  • It never hurts to include your Python version and operating system (OS). If you're not sure whether to include them, then do so.
  • If you can form a question with a question mark (?), that will allow some users to answer your question very quickly. It is especially important if you post a huge amount of text, since we could read the question, and then fill in the details afterward as necessary

What to NOT include in a post
  • Your own line numbers with the code. Anyone who wants to help you, has to copy hte code, and delete EVERY single number. You will end up with no responses.
  • Please do not take a screenshot of your traceback or code, just copy and paste the text of it in the post. If this text is within a popup that you cannot copy the text out of, please use this tool to acquire the text from within it (for windows users).
  • Leave out the text talk. atm (at the moment), IIRC (if i recall correctly). Stop assuming everyone knows what it means. You are on a forum, not texting your girlfirend.

Posts to not make
  • The same post in multiple sub forums.
  • If someone has told you to include more information, edit your original post or create a new post in your thread. Do not start a new, redundant thread.
  • A post in someone else's thread for your own separate problem. If you wish to reference the other thread, link to it in your own thread. This is especially true for "necro" posts, which is a post which has gone a great deal of time without any posts.

Modification of your posts
  • You are free to modify the title to more explicitly explain your problem better
  • If you need to modify a section of a post, please either make a new post, or append to the bottom of the post your corrected part. Please leave the rest of the post alone to not disrupt the flow of dialog.
  • Removal of the original post (OP) will get you a warning, continued locked posts, or even banned. Please do not do it. If you feel you need to remove the OP or change it, please ask a moderator/admin before doing so.

Forum Structure
It is better to just post in the section that best suits your question. Because if it is not, your post willl be moved, and will be mentioned on your thread anyway. It is better to just take a second before posting to decide where the post should be in the first place. This makes it a lot easier on us moderators and makes the whole forum database better organized.

  • General Discussions is just that...discussions. It is for questions about the Python language in general. For example: "How long did it take you to learn Python basics". It is not meant for questions about code. That is for General Coding Help.
  • Tutorials is an accumulation of tutorials that are approved by the majority of the forum moderators/admin.
  • Tutorial Submissions are for if you want to submit a tutorial of any kind. If it is approved, it will be moved to Tutorials.
  • Completed Scripts are for you completed programs. If you have multiple files, it is better to upload your code to Github and post a link to the repo as opposed to posting each file on the forum.
  • Jobs are for if you want to pay a Python programmer to do the work for you. Or it is for if you have a job opening for a programmer and want to announce it.
  • General Coding Help is where you post all your code and beginner questions that do not fit into other categories.
  • GUI is where you post code regarding GUI code, such as Tkinter, wxPython, Qt, etc.
  • Game Development is where you ask questions regarding a gaming GUI framework such as Pygame, or the logic behind game development.
  • Networking is for networking related questions about code. Such as sockets, Twisted, etc.
  • Web Development is for web dev related questions about code. Web frameworks such as Django, etc.
  • Challenges are for posting a challenge for the forum to tackle.
  • Project Euler is for project euler related questions.
  • Suggestions are for suggestions related to the forum itself. Such as forum placement, adding/removing a forum, hosting, etc.
  • Bar is for anything off topic. Free to discuss almost anything.

Following these guidelines will make it easier for everyone to see, understand, and organize your code and help you get an answer promptly. Ignoring these guidelines will make your post turn into a mirror of these guidelines from numerous users.
Last edited by metulburr on Thu Jun 19, 2014 11:20 pm, edited 41 times in total.
Reason: added modification of posts
New Users, Read This
OS Ubuntu 14.04, Arch Linux, Gentoo, Windows 7/8
https://github.com/metulburr
steam
User avatar
metulburr
 
Posts: 1376
Joined: Thu Feb 07, 2013 4:47 pm
Location: Elmira, NY

Return to Suggestions

Who is online

Users browsing this forum: No registered users and 1 guest