thread icon indicating copy to clipboard operation
thread copied to clipboard

Need to Update CODESTYLE.md for Documentation

Open ShiroTohu opened this issue 1 year ago • 0 comments

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.

  • [x] Syntax for callouts
  • [ ] How to write markdown documentation for methods
  • [ ] How to write markdown documentation for attributes
  • [ ] How to write markdown documentation for parameters
  • [x] Code blocks (using shorthands or full name?)

ShiroTohu avatar Jan 22 '24 07:01 ShiroTohu