Opened 11 years ago
Closed 11 years ago
#71 closed enhancement (fixed)
Will command keywords be written with camel-case in user documentation?
| Reported by: | Tom Goddard | Owned by: | Elaine Meng |
|---|---|---|---|
| Priority: | minor | Milestone: | |
| Component: | Help System | Version: | |
| Keywords: | Cc: | conrad@…, gregc@… | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | chimera |
Description
How should command keywords be written in user documentation. For example
set bgColor
set bgcolor
set bg_color
set bg-color
set bg color
The user will be able to type "set bgcolor" but other forms may make it more legible when reading the documentation. But we don't want users to feel compelled to type underscore characters.
In Chimera 1 we mostly use camel-case (set bgColor) for keywords in the documentation. Conrad was not satisfied with this solution in a brief discussion of the problem.
Note:
See TracTickets
for help on using tickets.
Yes camel case for the docs was decided at a Chimera meeting a week ago.