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

Improve READMEs + documentation #231

Open
tomhea opened this issue Sep 16, 2023 · 0 comments
Open

Improve READMEs + documentation #231

tomhea opened this issue Sep 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tomhea
Copy link
Owner

tomhea commented Sep 16, 2023

flipjump/stl/README.md

  • Flipjump tutorial: Give newcomers a clearer understanding of what FlipJump is and why they might want to use the standard library. This will be especially helpful for users who are not familiar with FlipJump. Create a useful program from scratch!
  • table of contents
  • Add examples of using the standard library. The usage of the stl should be documented much clearer.

README.md

  • table of contents

add a programs/README:

  • add a short README.md
  • add documentation line "// brief.. " for every programs/*.fj file, which explains what's its purpose.

flipjump/*.py

  • add a docstring to every python file in the flipjump package, and to every package's init.py too.
@tomhea tomhea changed the title Improve READMEs - minor fixes Improve READMEs + documentation Sep 17, 2023
@tomhea tomhea added the documentation Improvements or additions to documentation label Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant