Skip to content

Commit

Permalink
📚 docs: add back to top button in every readme section
Browse files Browse the repository at this point in the history
  • Loading branch information
adriamontoto committed Aug 8, 2024
1 parent bed4ef8 commit 22bc281
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<a name="readme-top"></a>

# 🐣💻 Developing Tools
<p align="center">
<a href="https://github.com/adriamontoto/developing-tools/actions/workflows/test.yaml?event=push&branch=develop" target="_blank">
Expand Down Expand Up @@ -26,13 +28,23 @@ These tools ⚒️ are intended to assist developers in identifying performance
- [License](#license)
<br><br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>



## Installation
```bash
pip install developing-tools
```
<br><br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>



## Utilization
### Execution Time
Expand All @@ -54,6 +66,10 @@ too_slow_function()
```
<br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>

### Retry It
The `retryit` decorator allows you to retry a function multiple times in case of failure. The decorator has two parameters:

Expand All @@ -77,6 +93,11 @@ failing_function()
```
<br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>


### Print Parameters
The `print_parameters` decorator allows you to print the parameters of a function. The decorator has two parameters:

Expand Down Expand Up @@ -105,6 +126,10 @@ normal_function(1, 'Hello', c=3, d=4)
```
<br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>

### Timeout
The `timeout` decorator allows you to set a maximum execution time for a function. The decorator has one parameter:

Expand All @@ -124,6 +149,17 @@ too_slow_function()
```
<br><br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>



## License
This project is licensed under the terms of the [MIT license](https://choosealicense.com/licenses/mit/).
<br><br>

<p align="right">
<a href="#readme-top">🔼 Back to top</a>
</p>

0 comments on commit 22bc281

Please sign in to comment.