Skip to content
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.

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

Add link to docs on decorators #101

Open
b-butler opened this issue Sep 17, 2020 · 1 comment
Open

Add link to docs on decorators #101

b-butler opened this issue Sep 17, 2020 · 1 comment
Labels
Contribution Welcome New developers are welcomed to contribute to this issue or pull request good first issue Good for newcomers

Comments

@b-butler
Copy link
Member

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)

@b-butler b-butler added the good first issue Good for newcomers label Sep 17, 2020
@vyasr
Copy link
Contributor

vyasr commented Sep 18, 2020

I'm all for linking to good docs on decorators. I don't think we should attempt to explain them ourselves, but links are great.

@kidrahahjo kidrahahjo added the Contribution Welcome New developers are welcomed to contribute to this issue or pull request label Nov 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution Welcome New developers are welcomed to contribute to this issue or pull request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants