Skip to content

Need to Update CODESTYLE.md for Documentation #91

Open
@ShiroTohu

Description

@ShiroTohu

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?)

Metadata

Metadata

Assignees

Labels

DocumentationAn issue/change with the documentation.

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions