Feature #1742
Write ctools coding conventions
| Status: | Closed | Start date: | 04/18/2016 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assigned To: |  Knödlseder Jürgen | % Done: | 100% | |
| Category: | - | |||
| Target version: | 1.1.0 | |||
| Duration: |
Description
So far we only have coding conventions for GammaLib, but we also need some for ctools. In particular since ctools has much more Python code than GammaLib, so we need Python coding conventions.
For example, private methods should be prepended with an underscore.
We should benefit from the Sonar analysis to define the Python coding conventions. We should also follow PEP-0008 (https://www.python.org/dev/peps/pep-0008/) and PEP-0257 (https://www.python.org/dev/peps/pep-0257/) for documentation.
Recurrence
No recurrence.
Related issues
History
#1
Updated by Knödlseder Jürgen about 8 years ago
- Related to Feature #1741: Refactor the cscripts to reduce the Sonar issues added
#2
Updated by Knödlseder Jürgen about 8 years ago
- Status changed from New to In Progress
- Assigned To set to Knödlseder Jürgen
Added an initial outline of the coding conventions document based on the PEP 0008 style guide. Now need to populate it.
#3
Updated by Knödlseder Jürgen about 8 years ago
- Status changed from In Progress to Closed
- Target version set to 1.1.0
- Start date set to 04/18/2016
- % Done changed from 0 to 100
I merged an initial version into devel. Still needs eventually improvements, but at least we have something there.