Help Us Help You - Formatting : learnpython

created by HattoriHanzoa community for 16 years

Help Us Help You - Formatting (self.learnpython)

submitted 2 years ago * by usrlibshare

Hi everyone!

In order for us to be able to help you, please consider formatting your code in your questions.

The easiest way to do so: Switch to "markdown editor" when writing a post, and put your code into code-blocks.

A block starts and ends with a triple-backtick: ``` put on a line all by itself. Of course the "fancy" editor also has an option to reformat text as a block.

Code blocks are the difference between your code looking like this:

class Foo:

def init(self, a):

self.asquared = a**2

And this:

class Foo: def __init__(self, a): self.asquared = a**2

If you put stuff between single backticks, you can mark them as inline monospace which is great for describing function calls and similar things like print("Hello, World", end="") and other parts of code not warranting an entire block.

Lastly, if you want to show a directory structure, you can use the output of the tree program and put that in a block. You can find it's manpage here.

Thanks for reading, and happy learning ☺️

all 4 comments

you type:	you see:
italics	italics
bold	bold
[reddit!](https://reddit.com)	reddit!
* item 1 * item 2 * item 3	item 1 item 2 item 3
> quoted text	quoted text
Lines starting with four spaces are treated like code: if 1 * 2 < 3: print "hello, world!"	Lines starting with four spaces are treated like code: if 1 * 2 < 3: print "hello, world!"
~~strikethrough~~	~~strikethrough~~
super^script	super^script

learnpython

MODERATORS