From: "Clément Pit-Claudel" <cpitclaudel@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 40784@debbugs.gnu.org
Subject: bug#40784: Clarifying the difference between fringe bitmaps and XBM images
Date: Thu, 23 Apr 2020 11:44:13 -0400 [thread overview]
Message-ID: <94200480-37e9-14c9-14e6-ab1275512171@gmail.com> (raw)
In-Reply-To: <83ftcucjzw.fsf@gnu.org>
On 23/04/2020 11.14, Eli Zaretskii wrote:
>> Cc: 40784@debbugs.gnu.org
>> From: Clément Pit-Claudel <cpitclaudel@gmail.com>
>> Date: Thu, 23 Apr 2020 10:35:54 -0400
>>
>> Of course: I am currently writing a mode that displays indicators either in the margins or in the fringes, depending on the value of a defcustom.
>> By default, I intended to use the same bitmaps in the margins and in the fringes. It took me a while to understand what I was doing wrong: I was seeing reversed bitmaps, but I hadn't considered the possibility that the two places where Emacs supports monochrome bitmaps would accept the same representation (unibyte strings) but use a different bit order.
>> The proposed patch updates the documentation to save the next person from experiencing the same pain.
>
> If so, then why do we need to mention this in the doc string? Won't
> the manual be enough? It is strange to mention just this factoid in
> the doc strings, when one can shoot themselves in the foot with
> bitmapped images in many exciting ways.
The docstrings are usually good enough that I seldom read the manuals :/
Having a brief warning in the docstring is useful in that case. But I'm happy to yield to your judgement.
Clément.
next prev parent reply other threads:[~2020-04-23 15:44 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-22 21:52 bug#40784: Clarifying the difference between fringe bitmaps and XBM images Clément Pit-Claudel
2020-04-23 14:30 ` Eli Zaretskii
2020-04-23 14:35 ` Clément Pit-Claudel
2020-04-23 15:14 ` Eli Zaretskii
2020-04-23 15:44 ` Clément Pit-Claudel [this message]
2020-04-25 9:59 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=94200480-37e9-14c9-14e6-ab1275512171@gmail.com \
--to=cpitclaudel@gmail.com \
--cc=40784@debbugs.gnu.org \
--cc=eliz@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).