Skip to content

Use function code to explain the code logic in DG #2317

Open
@nus-pe-bot

Description

@nus-pe-bot

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.



Some of the design explanation use the user command to describe the function logic

截屏2024-04-19 下午5.37.43.png


May try to use code function prototypes to describe, can be more straight forward for developers. (a good example below)

截屏2024-04-19 下午5.40.47.png


[original: nus-cs2113-AY2324S2/pe-interim#2159] [original labels: type.DocumentationBug severity.VeryLow]

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions