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

Need to Update CODESTYLE.md for Documentation #91

Open
2 of 5 tasks
ShiroTohu opened this issue Jan 22, 2024 · 0 comments
Open
2 of 5 tasks

Need to Update CODESTYLE.md for Documentation #91

ShiroTohu opened this issue Jan 22, 2024 · 0 comments
Assignees
Labels
Documentation An issue/change with the documentation.

Comments

@ShiroTohu
Copy link
Contributor

ShiroTohu commented Jan 22, 2024

Documentation Issue Report

Your issue may already be reported!
Please check out our active issues before creating one.

Description

When writing the documentation, I think the codestyle could be updated since there were some things that were a bit unclear when I was reviewing and making sure that the migrated documentation aligned with the predefined codestyle.

I think that these things needs to be added to the file.

  • Syntax for callouts
  • How to write markdown documentation for methods
  • How to write markdown documentation for attributes
  • How to write markdown documentation for parameters
  • Code blocks (using shorthands or full name?)
@ShiroTohu ShiroTohu added the Documentation An issue/change with the documentation. label Jan 22, 2024
@ShiroTohu ShiroTohu self-assigned this Jan 22, 2024
@caffeine-addictt caffeine-addictt transferred this issue from python-thread/thread.ngjx.org May 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation An issue/change with the documentation.
Projects
No open projects
Status: Backlog
Development

No branches or pull requests

1 participant