🐱💻 This markdown file contains information on how to write different things.
Within this markdown it will be explained how to write different type of things. These mostly contain Python code, or refer to general rules of writing (for instance markdown or READMEs).
💌 In this paragraph the basics of markdown will be demonstrated.
Markdown is a typesetting language, which is widely used to write README.md, stackoverflow.com questions or other documents. It contains the basic type settings, like:
code (`` ` code ``` - just delete the first space in the apostrophes)
When using these three apostrophes you can also specify which language you will type. For that you just name the language after the three apostrophes.
bold (** bold **, __ bold __)
italic (* italic *, _ italic _)
hyperlink ([text] (link))
With the hashtag, we can create different levels of headers. E.g.
As you can see, these are also displayed in the table of content.
We can create enumerated lists with the numbers
- This is the first entry
- This is the second
We can create normal lists with the minus sign
- This is the first bullet point
- This the second
We can also make a separator, using three minus signs in a row
Markdown also supports HTML-tags. However, GitHub, does only accept specific ones. Here are a few.
def sum_(a, b):
"""This calculates the sum from two numbers.
Parameters
----------
a: int
This is the first number of the sum.
b: int
This is the second number of the sum.
Returns
-------
This functions returns the sum from a and b.
"""
return a + b🛎️ Importing others peoples functions
In order to import other peoples functions and scripts we can use the import statement. As long as the scripts are on one level we can just do
from data_preprocessing import import_dataThis will import the function import_data() from the script data_preprocessing.