From: Glenn Morris Date: Fri, 7 Mar 2008 04:43:35 +0000 (+0000) Subject: Remove leading `*' from defcustom doc-strings. X-Git-Tag: emacs-pretest-23.0.90~7413 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=08f7d912afda0b42d8b0110710f79f31922c573d;p=emacs.git Remove leading `*' from defcustom doc-strings. --- diff --git a/lisp/calendar/cal-china.el b/lisp/calendar/cal-china.el index e1c6d2b9b8a..e7b8a531612 100644 --- a/lisp/calendar/cal-china.el +++ b/lisp/calendar/cal-china.el @@ -61,7 +61,7 @@ '(if (< year 1928) (+ 465 (/ 40.0 60.0)) 480) - "*Number of minutes difference between local standard time for Chinese + "Number of minutes difference between local standard time for Chinese calendar and Coordinated Universal (Greenwich) Time. Default is for Beijing. This is an expression in `year' since it changed at 1928-01-01 00:00:00 from UT+7:45:40 to UT+8." @@ -69,7 +69,7 @@ UT+7:45:40 to UT+8." :group 'chinese-calendar) (defcustom chinese-calendar-location-name "Beijing" - "*Name of location used for calculation of Chinese calendar." + "Name of location used for calculation of Chinese calendar." :type 'string :group 'chinese-calendar) @@ -77,7 +77,7 @@ UT+7:45:40 to UT+8." ; The correct value is as follows, but the Chinese calendrical ; authorities do NOT use DST in determining astronomical events: ; 60 - "*Number of minutes difference between daylight saving and standard time + "Number of minutes difference between daylight saving and standard time for Chinese calendar. Default is for no daylight saving time." :type 'integer :group 'chinese-calendar) @@ -86,14 +86,14 @@ for Chinese calendar. Default is for no daylight saving time." '(if (< year 1928) "PMT" "CST") - "*Abbreviated name of standard time zone used for Chinese calendar. + "Abbreviated name of standard time zone used for Chinese calendar. This is an expression depending on `year' because it changed at 1928-01-01 00:00:00 from `PMT' to `CST'." :type 'sexp :group 'chinese-calendar) (defcustom chinese-calendar-daylight-time-zone-name "CDT" - "*Abbreviated name of daylight saving time zone used for Chinese calendar." + "Abbreviated name of daylight saving time zone used for Chinese calendar." :type 'string :group 'chinese-calendar) @@ -103,7 +103,7 @@ at 1928-01-01 00:00:00 from `PMT' to `CST'." ; '(cond ((< 1986 year) (calendar-nth-named-day 1 0 4 year 10)) ; ((= 1986 year) '(5 4 1986)) ; (t nil)) - "*Sexp giving the date on which daylight saving time starts for Chinese + "Sexp giving the date on which daylight saving time starts for Chinese calendar. Default is for no daylight saving time. See documentation of `calendar-daylight-savings-starts'." :type 'sexp @@ -113,20 +113,20 @@ calendar. Default is for no daylight saving time. See documentation of ; The correct value is as follows, but the Chinese calendrical ; authorities do NOT use DST in determining astronomical events: ; '(if (<= 1986 year) (calendar-nth-named-day 1 0 9 year 11)) - "*Sexp giving the date on which daylight saving time ends for Chinese + "Sexp giving the date on which daylight saving time ends for Chinese calendar. Default is for no daylight saving time. See documentation of `calendar-daylight-savings-ends'." :type 'sexp :group 'chinese-calendar) (defcustom chinese-calendar-daylight-savings-starts-time 0 - "*Number of minutes after midnight that daylight saving time starts for + "Number of minutes after midnight that daylight saving time starts for Chinese calendar. Default is for no daylight saving time." :type 'integer :group 'chinese-calendar) (defcustom chinese-calendar-daylight-savings-ends-time 0 - "*Number of minutes after midnight that daylight saving time ends for + "Number of minutes after midnight that daylight saving time ends for Chinese calendar. Default is for no daylight saving time." :type 'integer :group 'chinese-calendar) diff --git a/lisp/calendar/timeclock.el b/lisp/calendar/timeclock.el index c4b1fd20f95..a69a6df2c2b 100644 --- a/lisp/calendar/timeclock.el +++ b/lisp/calendar/timeclock.el @@ -85,17 +85,17 @@ ;;; User Variables: (defcustom timeclock-file (convert-standard-filename "~/.timelog") - "*The file used to store timeclock data in." + "The file used to store timeclock data in." :type 'file :group 'timeclock) (defcustom timeclock-workday (* 8 60 60) - "*The length of a work period." + "The length of a work period." :type 'integer :group 'timeclock) (defcustom timeclock-relative t - "*Whether to make reported time relative to `timeclock-workday'. + "Whether to make reported time relative to `timeclock-workday'. For example, if the length of a normal workday is eight hours, and you work four hours on Monday, then the amount of time \"remaining\" on Tuesday is twelve hours -- relative to an averaged work period of @@ -106,7 +106,7 @@ previous days. This only affects the timeclock modeline display." :group 'timeclock) (defcustom timeclock-get-project-function 'timeclock-ask-for-project - "*The function used to determine the name of the current project. + "The function used to determine the name of the current project. When clocking in, and no project is specified, this function will be called to determine what is the current project to be worked on. If this variable is nil, no questions will be asked." @@ -114,7 +114,7 @@ If this variable is nil, no questions will be asked." :group 'timeclock) (defcustom timeclock-get-reason-function 'timeclock-ask-for-reason - "*A function used to determine the reason for clocking out. + "A function used to determine the reason for clocking out. When clocking out, and no reason is specified, this function will be called to determine what is the reason. If this variable is nil, no questions will be asked." @@ -122,7 +122,7 @@ If this variable is nil, no questions will be asked." :group 'timeclock) (defcustom timeclock-get-workday-function nil - "*A function used to determine the length of today's workday. + "A function used to determine the length of today's workday. The first time that a user clocks in each day, this function will be called to determine what is the length of the current workday. If the return value is nil, or equal to `timeclock-workday', nothing special @@ -133,7 +133,7 @@ that day has a length that is different from the norm." :group 'timeclock) (defcustom timeclock-ask-before-exiting t - "*If non-nil, ask if the user wants to clock out before exiting Emacs. + "If non-nil, ask if the user wants to clock out before exiting Emacs. This variable only has effect if set with \\[customize]." :set (lambda (symbol value) (if value @@ -151,7 +151,7 @@ This variable only has effect if set with \\[customize]." (defvar timeclock-modeline-display) (defcustom timeclock-use-display-time t - "*If non-nil, use `display-time-hook' for doing modeline updates. + "If non-nil, use `display-time-hook' for doing modeline updates. The advantage of this is that one less timer has to be set running amok in Emacs' process space. The disadvantage is that it requires you to have `display-time' running. If you don't want to use @@ -187,7 +187,7 @@ a positive argument to force an update." :require 'time) (defcustom timeclock-first-in-hook nil - "*A hook run for the first \"in\" event each day. + "A hook run for the first \"in\" event each day. Note that this hook is run before recording any events. Thus the value of `timeclock-hours-today', `timeclock-last-event' and the return value of function `timeclock-last-period' are relative previous @@ -196,34 +196,34 @@ to today." :group 'timeclock) (defcustom timeclock-load-hook nil - "*Hook that gets run after timeclock has been loaded." + "Hook that gets run after timeclock has been loaded." :type 'hook :group 'timeclock) (defcustom timeclock-in-hook nil - "*A hook run every time an \"in\" event is recorded." + "A hook run every time an \"in\" event is recorded." :type 'hook :group 'timeclock) (defcustom timeclock-day-over-hook nil - "*A hook that is run when the workday has been completed. + "A hook that is run when the workday has been completed. This hook is only run if the current time remaining is being displayed in the modeline. See the variable `timeclock-modeline-display'." :type 'hook :group 'timeclock) (defcustom timeclock-out-hook nil - "*A hook run every time an \"out\" event is recorded." + "A hook run every time an \"out\" event is recorded." :type 'hook :group 'timeclock) (defcustom timeclock-done-hook nil - "*A hook run every time a project is marked as completed." + "A hook run every time a project is marked as completed." :type 'hook :group 'timeclock) (defcustom timeclock-event-hook nil - "*A hook run every time any event is recorded." + "A hook run every time any event is recorded." :type 'hook :group 'timeclock) diff --git a/lisp/calendar/todo-mode.el b/lisp/calendar/todo-mode.el index 1727ed09d82..f7da678aed6 100644 --- a/lisp/calendar/todo-mode.el +++ b/lisp/calendar/todo-mode.el @@ -270,7 +270,7 @@ :group 'calendar) (defcustom todo-prefix "*/*" - "*TODO mode prefix for entries. + "TODO mode prefix for entries. This is useful in conjunction with `calendar' and `diary' if you use @@ -285,23 +285,23 @@ the diary file somewhat." :type 'string :group 'todo) (defcustom todo-file-do "~/.todo-do" - "*TODO mode list file." + "TODO mode list file." :type 'file :group 'todo) (defcustom todo-file-done "~/.todo-done" - "*TODO mode archive file." + "TODO mode archive file." :type 'file :group 'todo) (defcustom todo-mode-hook nil - "*TODO mode hooks." + "TODO mode hooks." :type 'hook :group 'todo) (defcustom todo-edit-mode-hook nil - "*TODO Edit mode hooks." + "TODO Edit mode hooks." :type 'hook :group 'todo) (defcustom todo-insert-threshold 0 - "*TODO mode insertion accuracy. + "TODO mode insertion accuracy. If you have 8 items in your TODO list, then you may get asked 4 questions by the binary insertion algorithm. However, you may not @@ -319,7 +319,7 @@ window." (defvar todo-edit-buffer " *TODO Edit*" "TODO Edit buffer name.") (defcustom todo-file-top "~/.todo-top" - "*TODO mode top priorities file. + "TODO mode top priorities file. Not in TODO format, but diary compatible. Automatically generated when `todo-save-top-priorities' is non-nil." @@ -327,26 +327,26 @@ Automatically generated when `todo-save-top-priorities' is non-nil." :group 'todo) (defcustom todo-print-function 'ps-print-buffer-with-faces - "*Function to print the current buffer." + "Function to print the current buffer." :type 'symbol :group 'todo) (defcustom todo-show-priorities 1 - "*Default number of priorities to show by \\[todo-top-priorities]. + "Default number of priorities to show by \\[todo-top-priorities]. 0 means show all entries." :type 'integer :group 'todo) (defcustom todo-print-priorities 0 - "*Default number of priorities to print by \\[todo-print]. + "Default number of priorities to print by \\[todo-print]. 0 means print all entries." :type 'integer :group 'todo) (defcustom todo-remove-separator t - "*Non-nil to remove category separators in\ + "Non-nil to remove category separators in\ \\[todo-top-priorities] and \\[todo-print]." :type 'boolean :group 'todo) (defcustom todo-save-top-priorities-too t - "*Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'." + "Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'." :type 'boolean :group 'todo) @@ -355,17 +355,17 @@ Automatically generated when `todo-save-top-priorities' is non-nil." ;; (defcustom todo-time-string-format "%:y-%02m-%02d %02H:%02M" - "*TODO mode time string format for done entries. + "TODO mode time string format for done entries. For details see the variable `time-stamp-format'." :type 'string :group 'todo) (defcustom todo-entry-prefix-function 'todo-entry-timestamp-initials - "*Function producing text to insert at start of todo entry." + "Function producing text to insert at start of todo entry." :type 'symbol :group 'todo) (defcustom todo-initials (or (getenv "INITIALS") (user-login-name)) - "*Initials of todo item author." + "Initials of todo item author." :type 'string :group 'todo)