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.

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

Jump to bottom

Sphinx docstrings #23

Closed
Sh-wayz opened this issue Dec 22, 2020 · 5 comments
Closed

Sphinx docstrings #23

Sh-wayz opened this issue Dec 22, 2020 · 5 comments
Assignees
@seven7ty @emerald73
Labels
Enhancement New feature, request, or thing Good First Issue Good for newcomers

Comments

@Sh-wayz
Copy link
Member

Sh-wayz commented Dec 22, 2020

Is your feature request related to a problem? Please describe.
Need me some hot docstrings.

Describe the solution you'd like
Add sphinx-styled descriptive docstrings to all classes/major functions.

Describe alternatives you've considered
no❤️
Additional info:
https://atom.io/packages/docblock-python
@Sh-wayz Sh-wayz self-assigned this Dec 22, 2020
@Iapetus-11
Copy link
Member

Iapetus-11 commented Dec 23, 2020 •
edited
Loading

this won't be finished and probably shouldn't be started till 4-create-packets is done?

Edit: nvm, we can do this for non packets and then merge it into master before starting in packet docstrings?

@Sh-wayz Sh-wayz assigned seven7ty and unassigned Sh-wayz Dec 23, 2020
@Sh-wayz
Copy link
Member Author

Sh-wayz commented Dec 23, 2020

Your problem now wulfster

@seven7ty seven7ty assigned Sh-wayz and unassigned seven7ty Dec 23, 2020
@Sh-wayz Sh-wayz assigned seven7ty and unassigned Sh-wayz Dec 23, 2020
@Sh-wayz
Copy link
Member Author

Sh-wayz commented Dec 23, 2020

dude you're the only one with a good docstring generator you do it

@seven7ty seven7ty assigned Sh-wayz and unassigned seven7ty Dec 23, 2020
@Iapetus-11 Iapetus-11 added the Enhancement New feature, request, or thing label Dec 24, 2020
@Sh-wayz Sh-wayz assigned seven7ty and unassigned Sh-wayz Dec 24, 2020
@seven7ty seven7ty assigned Sh-wayz and unassigned seven7ty Dec 27, 2020
@Sh-wayz Sh-wayz assigned seven7ty and unassigned Sh-wayz Dec 27, 2020
@seven7ty seven7ty assigned Sh-wayz and emerald73 and unassigned seven7ty and Sh-wayz Dec 28, 2020
@seven7ty seven7ty removed their assignment Dec 30, 2020
@seven7ty seven7ty assigned Iapetus-11 and unassigned seven7ty and emerald73 Dec 30, 2020
@Iapetus-11 Iapetus-11 removed their assignment Dec 30, 2020
@seven7ty seven7ty removed their assignment Dec 30, 2020
@seven7ty seven7ty removed their assignment Jan 11, 2021
@Sh-wayz Sh-wayz added the Good First Issue Good for newcomers label Jan 23, 2021
@Iapetus-11 Iapetus-11 changed the title Sphinx docstrings. Sphinx docstrings Jan 23, 2021
@Iapetus-11 Iapetus-11 mentioned this issue Jan 27, 2021
Open
@Iapetus-11
Copy link
Member

#244 has taken over the content of this issue.

@Sh-wayz
Copy link
Member Author

Sh-wayz commented Feb 10, 2021

RIP in peace. 😢

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@seven7ty seven7ty

@emerald73 emerald73

Labels
Enhancement New feature, request, or thing Good First Issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Iapetus-11 @seven7ty @Sh-wayz @emerald73