1
0
mirror of https://github.com/satwikkansal/wtfpython synced 2025-02-16 15:43:39 +01:00
wtfpython/CONTRIBUTING.md

37 lines
995 B
Markdown
Raw Normal View History

All patches are welcome. Feel free to even suggest some catch and funny titles for the existing Examples. I really want to make this collection as interesting to read as possible.
If you're adding a new example, please do create an issue to discuss it before submitting a patch.
2017-08-31 19:11:20 +05:30
You can use the following template for adding a new example:
2017-08-31 19:13:00 +05:30
<pre>
### Some fancy Title
```py
# Setting up the code.
# Preparation for the magic...
2017-08-31 19:11:20 +05:30
```
2017-08-31 19:13:00 +05:30
**Output (Python version):**
```py
>>> triggering_statement
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.
2017-08-31 19:11:20 +05:30
```py
2017-08-31 19:13:00 +05:30
Setting up examples for clarification (if necessary)
2017-08-31 19:11:20 +05:30
```
2017-08-31 19:13:00 +05:30
**Outupt:**
2017-08-31 19:11:20 +05:30
```py
2017-08-31 19:13:00 +05:30
>>> trigger # some example that makes it easy to unveil the magic
# some justified output
2017-08-31 19:11:20 +05:30
```
```
2017-08-31 19:13:00 +05:30
</pre>