Code documentation
ClosedPublic
Actions

Authored by dereckson on Feb 21 2016, 20:47.

Tags

None

Referenced Files

	F3746325: D299.diff
	Fri, Nov 15, 20:15

	Unknown Object (File)
	Sun, Nov 10, 14:47

	Unknown Object (File)
	Sun, Nov 10, 02:40

	Unknown Object (File)
	Sun, Nov 10, 02:39

	Unknown Object (File)
	Sat, Nov 9, 13:22

	Unknown Object (File)
	Sat, Nov 9, 10:39

	Unknown Object (File)
	Sat, Nov 9, 04:16

	Unknown Object (File)
	Fri, Nov 8, 23:52

View All Files

Subscribers

None

Details

Reviewers

dereckson

Commits

rNOTIFCLI531387531e88: Code documentation

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 Not Applicable

Unit

Tests Not Applicable

Event Timeline

dereckson updated this revision to Diff 702.Feb 21 2016, 20:47

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.

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

Dots everywhere.

dereckson accepted this revision.Feb 21 2016, 20:54

dereckson edited edge metadata.

This revision is now accepted and ready to land.Feb 21 2016, 20:54

Closed by commit rNOTIFCLI531387531e88: Code documentation (authored by dereckson, committed by dereckson). · Explain WhyFeb 21 2016, 20:54

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Path

Size

notifications

27 lines

Diff 704

View Options

Code documentationClosedPublicActions