search

SebastianLie / pe

0 stars 0 forks source link

User Guide: add documentation unclear #1

Open SebastianLie opened 4 years ago

SebastianLie commented 4 years ago

No format for dt,

Type of record type arguments not specified.

"In the future" is a very vague term.

nus-pe-bot commented 4 years ago

Team's Response

Hi there, thank you for taking the time to review my documentation. Many of the issues highlighted could be resolved by reading the entire user guide.

dt/ is covered in-depth in the calendar and reminder portion of UG which immediately follows the add section. The quickstart does provide some examples in the meanwhile.

The UG mentions that RECORD_TYPE must be in capital letters. The next few lines have "BMI" and "BLOODSUGAR" capitalised for this purpose. The command summary clarifies this as well.

"dt/ value must not be in the future" should be interpreted in the context of datetime. This means any datetime beyond the present dt/.