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

Simple Documentation #7

Open
EriKWDev opened this issue Jul 19, 2020 · 2 comments
Open

Simple Documentation #7

EriKWDev opened this issue Jul 19, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone
1.0.0

Comments

@EriKWDev
Copy link
Contributor

It would be nice if all the drawing functions in primitives.py had docstrings so that intellisense can show simple information when autocompleting and giving suggestions. This would be a very nice feature and would allow for a better user experience.
@EriKWDev EriKWDev added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jul 19, 2020
@EriKWDev EriKWDev added this to the 1.0.0 milestone Jul 19, 2020
@EriKWDev
Copy link
Contributor Author

This should no-longer be in primitives.py, but put inside fake_primitives.py. The drawing functions in primitives.py are never actually exposed to the user until runtime, meaning that the intellisense will only see the functions in fake_primitives.py

@EriKWDev
Copy link
Contributor Author

https://pypen.readthedocs.io/ has now been created. Documentations still needs to be written though xP

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
1 participant
@EriKWDev