Ticket #114 (closed task: fixed)

Opened 14 years ago

Last modified 13 years ago

Developers need well written and documented source

Reported by: tarmo Owned by: tarmo
Priority: critical Milestone:
Component: generic Version:
Keywords: Cc:
Time planned: Time remaining:
Time spent:

Description

Since the Plone API is quite huge, all new types of functionalities need to be documented in source code well enough so that others can easily understand what has been done and why.

Therefore the code should have:

  • class docstrings
  • method docstrings
  • normal comments for all non-trivial code
  • simple statements (split complex statements into several simple ones)

Change History

comment:1 Changed 14 years ago by tarmo

  • Status changed from new to assigned

comment:2 Changed 14 years ago by tarmo

  • Type changed from story to task

This is not a story, but a task.

comment:3 Changed 13 years ago by tarmo

  • Status changed from assigned to closed
  • Resolution set to fixed

I can probably close this - kind of a non-ticket, after all.

Note: See TracTickets for help on using tickets.