diff options
| author | Juanma Barranquero | 2004-06-07 20:33:00 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2004-06-07 20:33:00 +0000 |
| commit | 412f1fab56b54aff6662419ca5c88152609e3378 (patch) | |
| tree | d31fd6ac450a9c7c88c14ef014c4ea31558e61ae /src | |
| parent | 487327a9ef14093f5d793a14090c3edda146fe90 (diff) | |
| download | emacs-412f1fab56b54aff6662419ca5c88152609e3378.tar.gz emacs-412f1fab56b54aff6662419ca5c88152609e3378.zip | |
(Fuser_login_name, Ffloat_time, Fencode_time, Fcurrent_time_string)
(Fcurrent_time_zone, Finsert_buffer_substring, Ftranspose_regions):
Doc fixes.
Diffstat (limited to 'src')
| -rw-r--r-- | src/editfns.c | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/src/editfns.c b/src/editfns.c index 207faf492ab..c9dd4ecefdf 100644 --- a/src/editfns.c +++ b/src/editfns.c | |||
| @@ -1218,7 +1218,7 @@ If POS is out of range, the value is nil. */) | |||
| 1218 | DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0, | 1218 | DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0, |
| 1219 | doc: /* Return the name under which the user logged in, as a string. | 1219 | doc: /* Return the name under which the user logged in, as a string. |
| 1220 | This is based on the effective uid, not the real uid. | 1220 | This is based on the effective uid, not the real uid. |
| 1221 | Also, if the environment variable LOGNAME or USER is set, | 1221 | Also, if the environment variables LOGNAME or USER are set, |
| 1222 | that determines the value of this function. | 1222 | that determines the value of this function. |
| 1223 | 1223 | ||
| 1224 | If optional argument UID is an integer, return the login name of the user | 1224 | If optional argument UID is an integer, return the login name of the user |
| @@ -1430,7 +1430,7 @@ lisp_time_argument (specified_time, result, usec) | |||
| 1430 | 1430 | ||
| 1431 | DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0, | 1431 | DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0, |
| 1432 | doc: /* Return the current time, as a float number of seconds since the epoch. | 1432 | doc: /* Return the current time, as a float number of seconds since the epoch. |
| 1433 | If an argument is given, it specifies a time to convert to float | 1433 | If SPECIFIED-TIME is given, it is the time to convert to float |
| 1434 | instead of the current time. The argument should have the forms: | 1434 | instead of the current time. The argument should have the forms: |
| 1435 | (HIGH . LOW) or (HIGH LOW USEC) or (HIGH LOW . USEC). | 1435 | (HIGH . LOW) or (HIGH LOW USEC) or (HIGH LOW . USEC). |
| 1436 | Thus, you can use times obtained from `current-time' | 1436 | Thus, you can use times obtained from `current-time' |
| @@ -1660,7 +1660,7 @@ are used as SECOND through YEAR, and the *last* argument is used as ZONE. | |||
| 1660 | The intervening arguments are ignored. | 1660 | The intervening arguments are ignored. |
| 1661 | This feature lets (apply 'encode-time (decode-time ...)) work. | 1661 | This feature lets (apply 'encode-time (decode-time ...)) work. |
| 1662 | 1662 | ||
| 1663 | Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed; | 1663 | Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed; |
| 1664 | for example, a DAY of 0 means the day preceding the given month. | 1664 | for example, a DAY of 0 means the day preceding the given month. |
| 1665 | Year numbers less than 100 are treated just like other year numbers. | 1665 | Year numbers less than 100 are treated just like other year numbers. |
| 1666 | If you want them to stand for years in this century, you must do that yourself. | 1666 | If you want them to stand for years in this century, you must do that yourself. |
| @@ -1745,8 +1745,8 @@ The format is `Sun Sep 16 01:03:52 1973'. | |||
| 1745 | However, see also the functions `decode-time' and `format-time-string' | 1745 | However, see also the functions `decode-time' and `format-time-string' |
| 1746 | which provide a much more powerful and general facility. | 1746 | which provide a much more powerful and general facility. |
| 1747 | 1747 | ||
| 1748 | If an argument is given, it specifies a time to format | 1748 | If SPECIFIED-TIME is given, it is a time to format instead |
| 1749 | instead of the current time. The argument should have the form: | 1749 | of the current time. The argument should have the form: |
| 1750 | (HIGH . LOW) | 1750 | (HIGH . LOW) |
| 1751 | or the form: | 1751 | or the form: |
| 1752 | (HIGH LOW . IGNORED). | 1752 | (HIGH LOW . IGNORED). |
| @@ -1801,7 +1801,7 @@ This returns a list of the form (OFFSET NAME). | |||
| 1801 | OFFSET is an integer number of seconds ahead of UTC (east of Greenwich). | 1801 | OFFSET is an integer number of seconds ahead of UTC (east of Greenwich). |
| 1802 | A negative value means west of Greenwich. | 1802 | A negative value means west of Greenwich. |
| 1803 | NAME is a string giving the name of the time zone. | 1803 | NAME is a string giving the name of the time zone. |
| 1804 | If an argument is given, it specifies when the time zone offset is determined | 1804 | If SPECIFIED-TIME is given, the time zone offset is determined from it |
| 1805 | instead of using the current time. The argument should have the form: | 1805 | instead of using the current time. The argument should have the form: |
| 1806 | (HIGH . LOW) | 1806 | (HIGH . LOW) |
| 1807 | or the form: | 1807 | or the form: |
| @@ -2349,8 +2349,8 @@ DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_subst | |||
| 2349 | 1, 3, 0, | 2349 | 1, 3, 0, |
| 2350 | doc: /* Insert before point a substring of the contents of BUFFER. | 2350 | doc: /* Insert before point a substring of the contents of BUFFER. |
| 2351 | BUFFER may be a buffer or a buffer name. | 2351 | BUFFER may be a buffer or a buffer name. |
| 2352 | Arguments START and END are character numbers specifying the substring. | 2352 | Arguments START and END are character positions specifying the substring. |
| 2353 | They default to the beginning and the end of BUFFER. */) | 2353 | They default to the values of (point-min) and (point-max) in BUFFER. */) |
| 2354 | (buffer, start, end) | 2354 | (buffer, start, end) |
| 2355 | Lisp_Object buffer, start, end; | 2355 | Lisp_Object buffer, start, end; |
| 2356 | { | 2356 | { |
| @@ -2827,6 +2827,7 @@ It returns the number of characters changed. */) | |||
| 2827 | 2827 | ||
| 2828 | DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r", | 2828 | DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r", |
| 2829 | doc: /* Delete the text between point and mark. | 2829 | doc: /* Delete the text between point and mark. |
| 2830 | |||
| 2830 | When called from a program, expects two arguments, | 2831 | When called from a program, expects two arguments, |
| 2831 | positions (integers or markers) specifying the stretch to be deleted. */) | 2832 | positions (integers or markers) specifying the stretch to be deleted. */) |
| 2832 | (start, end) | 2833 | (start, end) |
| @@ -3875,11 +3876,11 @@ transpose_markers (start1, end1, start2, end2, | |||
| 3875 | } | 3876 | } |
| 3876 | 3877 | ||
| 3877 | DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0, | 3878 | DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0, |
| 3878 | doc: /* Transpose region START1 to END1 with START2 to END2. | 3879 | doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2. |
| 3879 | The regions may not be overlapping, because the size of the buffer is | 3880 | The regions may not be overlapping, because the size of the buffer is |
| 3880 | never changed in a transposition. | 3881 | never changed in a transposition. |
| 3881 | 3882 | ||
| 3882 | Optional fifth arg LEAVE_MARKERS, if non-nil, means don't update | 3883 | Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update |
| 3883 | any markers that happen to be located in the regions. | 3884 | any markers that happen to be located in the regions. |
| 3884 | 3885 | ||
| 3885 | Transposing beyond buffer boundaries is an error. */) | 3886 | Transposing beyond buffer boundaries is an error. */) |