diff --git a/participants/scipy_018/doc/README.md b/participants/scipy_018/doc/README.md index a1542d9..46bcb46 100644 --- a/participants/scipy_018/doc/README.md +++ b/participants/scipy_018/doc/README.md @@ -1,13 +1,16 @@ -Ok so I guess you are reading this cuz you wanna use my code. There are some -functions that do stuf and thats: +The PR_tutorial package contains some simple functions to demonstrate the process of creating and merging a PR request. + +One function computes the factorial of a number: >>> from simple_functions import factorial >>> factorial(10) - 9 + 3628800 -and this other part does something. I forget why that I did it: +Another function computes the Fibonacci sequence: - >>> fibonnaccci(100) + >>> from simple_functions import fibonacci + >>> fibonacci(100) [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89] -If you can't use it, its kind of your problem, not mine! +If you find a bug, please report it on the issue tracker +or submit a pull request with a fix.