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

docstrings #36

Open
byteface opened this issue Aug 24, 2021 · 0 comments
Open

docstrings #36

byteface opened this issue Aug 24, 2021 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs https://up-for-grabs.net/#/

Comments

@byteface
Copy link
Owner

byteface commented Aug 24, 2021

when i first copy and paste method names from MDN page. i just turn the description of the method into a comment then start trying to make them work.

however later we have docstrings that looks like this

def somemethod(x,y,z):
""" some description of the method """

what I'd prefer is they all had proper docstrings and sometimes have been replacing them as I see them. so you will see a mix of both styles in the code. But feel free to help on that effort. they are quite quick to do. as you can auto gen the docstring. then as you start to type a description copilot usually does a semi decent job of finishing it. If you see any docstrings that are done like the example above. just feel free to change them to the proper ones as you go.

@byteface byteface added the help wanted Extra attention is needed label Aug 24, 2021
@byteface byteface added good first issue Good for newcomers up-for-grabs https://up-for-grabs.net/#/ help wanted Extra attention is needed enhancement New feature or request and removed help wanted Extra attention is needed labels Nov 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs https://up-for-grabs.net/#/
Projects
None yet
Development

No branches or pull requests

1 participant