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

Messy documentation #21

Open
rayzchen opened this issue Aug 12, 2021 · 7 comments
Open

Messy documentation #21

rayzchen opened this issue Aug 12, 2021 · 7 comments
Labels
Meta: Help Wanted Extra attention is needed Topic: Repository Bugs or enhancements to do with the repository itself Type: Documentation Improvements or additions to documentation
Projects
PyUnity

Comments

@rayzchen
Copy link
Collaborator

The README, docs and just everything documentation-related is not good. The README is too full of documentation and not actually what PyUnity is about, and the first impression to it is that PyUnity is just a set of bindings to the Unity Game Engine. Half the docstrings are missing and tutorials lack detail.
@rayzchen rayzchen added Type: Documentation Improvements or additions to documentation Meta: Help Wanted Extra attention is needed labels Aug 12, 2021
@SomeRandomDudeCoding
Copy link

What

@rayzchen
Copy link
Collaborator Author

Updated README and some docstrings. Tutorials reformatted.

@Shresth001
Copy link
Collaborator

Can we close this issue now ?

@rayzchen rayzchen added this to Plans in PyUnity Oct 13, 2021
@rayzchen
Copy link
Collaborator Author

rayzchen commented Nov 1, 2021

Need to add docstrings to most of pyunity.gui and pyunity.values, also update the tutorials and create new ones.

@rayzchen
Copy link
Collaborator Author

Planning on a full game tutorial

@rayzchen rayzchen added the Topic: Repository Bugs or enhancements to do with the repository itself label May 21, 2022
@rayzchen
Copy link
Collaborator Author

Maybe some way to fix or update arguments section in docstrings based on stubs? May have to wait until stubs are finished or up-to-date.

@rayzchen
Copy link
Collaborator Author

Added page documenting helper functions in prepare.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Meta: Help Wanted Extra attention is needed Topic: Repository Bugs or enhancements to do with the repository itself Type: Documentation Improvements or additions to documentation
Projects
PyUnity
Status: Plans
PyUnity
Plans
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rayzchen @Shresth001 @SomeRandomDudeCoding