Change the position of the notes.

* Moves the position of the information regarding the
Python version so that it is not skipped by the readers.
* Also moves the position of the instructions for reproducing the
"Skipping lines" example to just below the output.

Closes https://github.com/satwikkansal/wtfPython/issues/17
This commit is contained in:
Satwik Kansal 2017-09-01 22:24:47 +05:30
parent 046663efff
commit 82bbded3da
1 changed files with 6 additions and 4 deletions

10
README.md vendored
View File

@ -98,6 +98,8 @@ So, here ya go...
# Structure of the Examples
**Note:** All the examples mentioned below are tested on Python 3.5.2 interactive interpreter, and they should work for all the Python versions unless explicitly specified in the example description.
All the examples are structured like below:
### Some fancy Title
@ -114,10 +116,9 @@ Probably unexpected output
```
(Optional): One line describing the unexpected output.
**Note:** All the examples mentioned below are run on Python 3.5.2 interactive interpreter unless explicitly specified.
#### 💡 Explanation:
* Brief explanation of what's happening and why is it happening.
```py
Setting up examples for clarification (if necessary)
@ -151,6 +152,7 @@ Now, just run `wtfpython` at the command line which will open this collection in
### Skipping lines?
**Output:**
```py
>>> value = 11
>>> valuе = 32
@ -160,6 +162,8 @@ Now, just run `wtfpython` at the command line which will open this collection in
Wut?
**Note:** The easiest way to reproduce this is to simply copy the statements from the above snippet and paste them into your file/shelll.
#### Explanation
Some Unicode characters look identical to ASCII ones, but are considered distinct by the interpreter.
@ -171,8 +175,6 @@ Some Unicode characters look identical to ASCII ones, but are considered distinc
42
```
**Note:** The easiest way to reproduce this is to simply copy the statements from the above snippet and paste them into your file/shelll.
---
### Well, something is fishy...