Page MenuHomeDevCentral

Code documentation
ClosedPublic

Authored by dereckson on Feb 21 2016, 20:47.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Dec 10, 11:04
Unknown Object (File)
Mon, Dec 9, 04:35
Unknown Object (File)
Fri, Dec 6, 09:49
Unknown Object (File)
Wed, Dec 4, 08:07
Unknown Object (File)
Sun, Dec 1, 09:40
Unknown Object (File)
Sun, Dec 1, 09:20
Unknown Object (File)
Mon, Nov 25, 09:42
Unknown Object (File)
Fri, Nov 22, 13:34
Subscribers
None

Details

Summary

The code prototype were considered as self-documented, using clear
variable and function names, dividing the problem to solve into
small functions.

We add documentation to add some notes and provide a foundation for
the future evolution of the code.

In addition, PEP 0257 convention is followed.

Test Plan

Proofread the code comments.

Diff Detail

Repository
rNOTIFCLI Notifications center CLI client
Lint
Lint Passed
Unit
No Test Coverage
Branch
missing-docstring
Build Status
Buildable 386
Build 463: arc lint + arc unit

Event Timeline

dereckson retitled this revision from to Code documentation.
dereckson updated this object.
dereckson edited the test plan for this revision. (Show Details)
dereckson added a reviewer: dereckson.
dereckson edited edge metadata.

PEP-0257: "The docstring is a phrase ending in a period."

dereckson edited edge metadata.

Dots everywhere.

dereckson edited edge metadata.
This revision is now accepted and ready to land.Feb 21 2016, 20:54
This revision was automatically updated to reflect the committed changes.