mirror of
https://github.com/satwikkansal/wtfpython
synced 2024-11-22 11:04:25 +01:00
Structure of Example: Enhance formatting
Made the structure of example more distinguishing
This commit is contained in:
commit
0d55258685
52
README.md
vendored
52
README.md
vendored
@ -108,32 +108,32 @@ So, here ya go...
|
|||||||
|
|
||||||
All the examples are structured like below:
|
All the examples are structured like below:
|
||||||
|
|
||||||
### Some fancy Title
|
> ### Some fancy Title
|
||||||
|
>
|
||||||
```py
|
> ```py
|
||||||
# Setting up the code.
|
> # Setting up the code.
|
||||||
# Preparation for the magic...
|
> # Preparation for the magic...
|
||||||
```
|
> ```
|
||||||
|
>
|
||||||
**Output (Python version):**
|
> **Output (Python version):**
|
||||||
```py
|
> ```py
|
||||||
>>> triggering_statement
|
> >>> triggering_statement
|
||||||
Probably unexpected output
|
> Probably unexpected output
|
||||||
```
|
> ```
|
||||||
(Optional): One line describing the unexpected output.
|
> (Optional): One line describing the unexpected output.
|
||||||
|
>
|
||||||
|
>
|
||||||
#### 💡 Explanation:
|
> #### 💡 Explanation:
|
||||||
|
>
|
||||||
* Brief explanation of what's happening and why is it happening.
|
> * Brief explanation of what's happening and why is it happening.
|
||||||
```py
|
> ```py
|
||||||
Setting up examples for clarification (if necessary)
|
> Setting up examples for clarification (if necessary)
|
||||||
```
|
> ```
|
||||||
**Output:**
|
> **Output:**
|
||||||
```py
|
> ```py
|
||||||
>>> trigger # some example that makes it easy to unveil the magic
|
> >>> trigger # some example that makes it easy to unveil the magic
|
||||||
# some justified output
|
> # some justified output
|
||||||
```
|
> ```
|
||||||
|
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
Loading…
Reference in New Issue
Block a user