* bug#6821: Documentation: `insert' needs refilled
@ 2010-08-08 0:19 MON KEY
2010-08-14 23:25 ` Chong Yidong
0 siblings, 1 reply; 4+ messages in thread
From: MON KEY @ 2010-08-08 0:19 UTC (permalink / raw)
To: 6821
Documentation: `insert' needs refilled.
,---- (documentation 'insert)
| Insert the arguments, either strings or characters, at point.
| Point and before-insertion markers move forward to end up
| after the inserted text.
| Any other markers at the point of insertion remain before the text.
|
| If the current buffer is multibyte, unibyte strings are converted
| to multibyte for insertion (see `string-make-multibyte').
| If the current buffer is unibyte, multibyte strings are converted
| to unibyte for insertion (see `string-make-unibyte').
|
| When operating on binary data, it may be necessary to preserve the
| original bytes of a unibyte string when inserting it into a multibyte
| buffer; to accomplish this, apply `string-as-multibyte' to the string
| and insert the result.
|
| (fn &rest ARGS)
`----
At this sentence:
"Point and before-insertion markers move forward to end up
after the inserted text."
^^
Problem verified current through Bzr-100972
--
/s_P\
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#6821: Documentation: `insert' needs refilled
2010-08-08 0:19 bug#6821: Documentation: `insert' needs refilled MON KEY
@ 2010-08-14 23:25 ` Chong Yidong
2010-08-15 20:28 ` MON KEY
0 siblings, 1 reply; 4+ messages in thread
From: Chong Yidong @ 2010-08-14 23:25 UTC (permalink / raw)
To: MON KEY; +Cc: 6821
> "Point and before-insertion markers move forward to end up
> after the inserted text."
Docstrings in Emacs have used this kind of indentation for ages.
It's idiosyncratic, but there's no harm keeping in.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#6821: Documentation: `insert' needs refilled
2010-08-14 23:25 ` Chong Yidong
@ 2010-08-15 20:28 ` MON KEY
2010-08-16 3:16 ` Chong Yidong
0 siblings, 1 reply; 4+ messages in thread
From: MON KEY @ 2010-08-15 20:28 UTC (permalink / raw)
To: Chong Yidong; +Cc: 6821
On Sat, Aug 14, 2010 at 7:25 PM, Chong Yidong <cyd@stupidchicken.com> wrote:
>> "Point and before-insertion markers move forward to end up
>> after the inserted text."
>
> Docstrings in Emacs have used this kind of indentation for ages.
> It's idiosyncratic, but there's no harm keeping in.
>
OK.
Out of curiosity is there a particular reason/rationale for why this
type of BOL offset appears for only _some_ docstrings?
Also, what is threshold for determining when it _is_ reasonable to
notify that a doc needs refilled?
I ask because I have the impression that Emacs 23.2 seems to have more
occurrences of these "idiosyncratic"
indentations than previous versions (though this impression may be do
to increased familiarity w/ the docs.)
Indeed, w/ some docstring instances the anomalous indentation occurs
across multiple lines to an extent that it can impede/hinder ones
ability to grok the doc.
--
/s_P\
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#6821: Documentation: `insert' needs refilled
2010-08-15 20:28 ` MON KEY
@ 2010-08-16 3:16 ` Chong Yidong
0 siblings, 0 replies; 4+ messages in thread
From: Chong Yidong @ 2010-08-16 3:16 UTC (permalink / raw)
To: MON KEY; +Cc: 6821
MON KEY <monkey@sandpframing.com> writes:
> I ask because I have the impression that Emacs 23.2 seems to have more
> occurrences of these "idiosyncratic" indentations than previous
> versions (though this impression may be do to increased familiarity w/
> the docs.)
Actually, I think most of these occurrences are old.
In general, I would not worry about the indentation; instead, focus on
the content of the docstrings.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2010-08-16 3:16 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-08-08 0:19 bug#6821: Documentation: `insert' needs refilled MON KEY
2010-08-14 23:25 ` Chong Yidong
2010-08-15 20:28 ` MON KEY
2010-08-16 3:16 ` Chong Yidong
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).