-
Notifications
You must be signed in to change notification settings - Fork 19
Open
Labels
Contribution WelcomeNew developers are welcomed to contribute to this issue or pull requestNew developers are welcomed to contribute to this issue or pull requestgood first issueGood for newcomersGood for newcomers
Description
Issue Description
In the signac tutorial, we introduce the decorator syntax @ without defining what a Python decorator is or linking to documentation on decorators. A new user expressed some confusion at this point in the documentation. As decorators are a nice syntactic feature of Python, but potential not used commonly enough to be known by users who are newer to Python,
Proposed change
I think we should add a link to official docs on decorators (these are the best I could find https://www.python.org/dev/peps/pep-0318/ and https://docs.python.org/3/whatsnew/2.4.html?highlight=decorators#pep-318-decorators-for-functions-and-methods)
Metadata
Metadata
Assignees
Labels
Contribution WelcomeNew developers are welcomed to contribute to this issue or pull requestNew developers are welcomed to contribute to this issue or pull requestgood first issueGood for newcomersGood for newcomers