Skip to content

Update decorator description. #2379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
algmyr wants to merge 2 commits into from
Closed

Update decorator description. #2379

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85d4bed
Update decorator description.
algmyr Jan 14, 2023
b493a70
Merge branch 'main' into patch-1
Xithrius Nov 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion bot/resources/tags/decorators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,23 @@ embed:
---
A decorator is a function that modifies another function.

Consider the following example of a timer decorator:
Given the decorator
Copy link
Copy Markdown
Contributor

@shtlrs shtlrs Mar 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather we'd give the timer example.
decorators are not an easy topic for beginners, and if we're explaining how interpreters translate the syntax & how it executes them, we might as well keep the same example for consistency and also to avoid confusing beginners.

So you would demo the equivalent syntaxes, then you would give the execute example of both of them to demonstrate it even further

```py
def deco(f):
...
```
then the following constructs are functionally equivalent
```py
def tmp_fun():
...
fun = deco(tmp_fun)

@deco
def fun():
...
```

As an example consider the following example of a timer decorator:
```py
>>> import time
>>> def timer(f):
Expand Down