Opened 13 years ago
Last modified 10 years ago
#11141 new enhancement
Add ConfigSection to all sections
| Reported by: | Dirk Stöcker | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | next-major-releases | 
| Component: | general | Version: | |
| Severity: | normal | Keywords: | documentation configsection | 
| Cc: | Branch: | ||
| Release Notes: | |||
| API Changes: | |||
| Internal Changes: | |||
Description
After I modified the TracIniAdminPlugin to show the description for sections I noticed that a proper description is very helpful.
Please add a ConfigSection entry for each section, not only for the default-empty ones. Also this would improve TracIni.
Attachments (0)
Change History (3)
comment:1 by , 13 years ago
| Keywords: | documentation configsection added | 
|---|---|
| Milestone: | → next-major-releases | 
comment:2 by , 10 years ago
I can have a look at this if someone could point out how this would need to be done.
comment:3 by , 10 years ago
We'd need text for every section in TracIni#Referenceforsettings. I'm unsure what useful text would be for a section such as TracIni#ticket-section: Configuration options for the TicketModule? Many of them appear to be self-explanatory, and sections which don't have a consistent set of options should probably be broken out into more self-explanatory sections (e.g. #11985).



  
Good idea, although a lot of the core sections are grab bags of configuration settings only vaguely related to one specific module. The ConfigSection documentation is most useful when all the entries in a section follows a specific logic. But even otherwise, an introductory statement wouldn't hurt.