Disabling quote conversion in docstringsHow to retrieve docstrings from functions and variables?Optional docstring in defun“helm-documentation”? (search docstrings like apropos-documentation but with helm)How can I hide formatting marks after the formatting they define has been applied in markdown mode?How to keep indented under plain list items in org-modeHow can I record where a function is defined if it's done indirectly?Format Haskell type signatures to be multi-linefill-paragraph in programmingWhat function are associated with these expression evaluation commands in buffers?Change doc string summary of a function on the fly
As a GM, is it bad form to ask for a moment to think when improvising?
Dirichlet series with a single zero
Can my 2 children, aged 10 and 12, who are US citizens, travel to the USA on expired American passports?
How to pass hash as password to ssh server
Sheared off exhasut pipe: How to fix without a welder?
Is any special diet an effective treatment of autism?
Is there precedent or are there procedures for a US president refusing to concede to an electoral defeat?
Some Russian letters overlap the next line of text when used in drop caps
Clarification of algebra in moment generating functions
How to deal with employer who keeps me at work after working hours
In linear regression why does regularisation penalise the parameter values as well?
Hostile Divisor Numbers
Why did the Apollo 13 crew extend the LM landing gear?
Why did WWI include Japan?
weird pluperfect subjunctive in Eutropius
GitLab account hacked and repo wiped
Sparring against two opponents test
Determine if a grid contains another grid
All of my Firefox add-ons been disabled suddenly, how can I re-enable them?
Is there a word that describes the unjustified use of a more complex word?
Has the Hulk always been able to talk?
Where are the "shires" in the UK?
How can a hefty sand storm happen in a thin atmosphere like Martian?
Constitutional limitation of criminalizing behavior in US law?
Disabling quote conversion in docstrings
How to retrieve docstrings from functions and variables?Optional docstring in defun“helm-documentation”? (search docstrings like apropos-documentation but with helm)How can I hide formatting marks after the formatting they define has been applied in markdown mode?How to keep indented under plain list items in org-modeHow can I record where a function is defined if it's done indirectly?Format Haskell type signatures to be multi-linefill-paragraph in programmingWhat function are associated with these expression evaluation commands in buffers?Change doc string summary of a function on the fly
(defun foo ()
"`bar'")
The ASCII quotes in this docstring are displayed as typographical quotes by describe-function
.
Is it possible to have them displayed in their original form?
help formatting doc-strings
add a comment |
(defun foo ()
"`bar'")
The ASCII quotes in this docstring are displayed as typographical quotes by describe-function
.
Is it possible to have them displayed in their original form?
help formatting doc-strings
add a comment |
(defun foo ()
"`bar'")
The ASCII quotes in this docstring are displayed as typographical quotes by describe-function
.
Is it possible to have them displayed in their original form?
help formatting doc-strings
(defun foo ()
"`bar'")
The ASCII quotes in this docstring are displayed as typographical quotes by describe-function
.
Is it possible to have them displayed in their original form?
help formatting doc-strings
help formatting doc-strings
edited 50 mins ago
Drew
49.6k463108
49.6k463108
asked 5 hours ago
ToothrotToothrot
914412
914412
add a comment |
add a comment |
2 Answers
2
active
oldest
votes
TL;DR
(setq text-quoting-style 'grave)
Is it possible to have them displayed in their original form?
Yes, see (elisp) Text Quoting Style
, specifically the description of the user option text-quoting-style
:
text-quoting-style is a variable defined in ‘doc.c’.
Its value is nil
Probably introduced at or before Emacs version 25.1.
Documentation:
Style to use for single quotes in help and messages.
Its value should be a symbol. It works by substituting certain single
quotes for grave accent and apostrophe. This is done in help output
(but not for display of Info manuals) and in functions like ‘message’
and ‘format-message’. It is not done in ‘format’.
‘curve’ means quote with curved single quotes ‘like this’.
‘straight’ means quote with straight apostrophes 'like this'.
‘grave’ means quote with grave accent and apostrophe `like this';
i.e., do not alter quote marks. The default value nil acts like
‘curve’ if curved single quotes are displayable, and like ‘grave’
otherwise.
See also the relevant paragraph of (emacs) Text Display
:
Emacs tries to determine if the curved quotes ‘‘’ and ‘’’ can be
displayed on the current display. By default, if this seems to be so,
then Emacs will translate the ASCII quotes (‘`’ and ‘'’), when they
appear in messages and help texts, to these curved quotes. You can
influence or inhibit this translation by customizing the user option
‘text-quoting-style’ (see (elisp)Keys in Documentation).
add a comment |
Basil's answer covers the needs of the end-user.
If you're writing elisp docstrings for other people, however, you (unfortunately) can't rely on everyone configuring text-quoting-style
to grave
, so when you need to ensure that quotes are not converted, you have to use an escaping syntax:
(defun foo ()
"Something about \='foo")
Will ensure that, regardless of text-quoting-style
, the docstring is rendered like so:
Something about 'foo
This is very important if your docstring contains elisp code samples which include quotes, as the default behaviour would render such code invalid (and in a way which might be incredibly difficult for users to discern).
See also Basil's link to (elisp) Text Quoting Style
, which provides another example.
add a comment |
Your Answer
StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "583"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);
else
createEditor();
);
function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);
);
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2femacs.stackexchange.com%2fquestions%2f50337%2fdisabling-quote-conversion-in-docstrings%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
2 Answers
2
active
oldest
votes
2 Answers
2
active
oldest
votes
active
oldest
votes
active
oldest
votes
TL;DR
(setq text-quoting-style 'grave)
Is it possible to have them displayed in their original form?
Yes, see (elisp) Text Quoting Style
, specifically the description of the user option text-quoting-style
:
text-quoting-style is a variable defined in ‘doc.c’.
Its value is nil
Probably introduced at or before Emacs version 25.1.
Documentation:
Style to use for single quotes in help and messages.
Its value should be a symbol. It works by substituting certain single
quotes for grave accent and apostrophe. This is done in help output
(but not for display of Info manuals) and in functions like ‘message’
and ‘format-message’. It is not done in ‘format’.
‘curve’ means quote with curved single quotes ‘like this’.
‘straight’ means quote with straight apostrophes 'like this'.
‘grave’ means quote with grave accent and apostrophe `like this';
i.e., do not alter quote marks. The default value nil acts like
‘curve’ if curved single quotes are displayable, and like ‘grave’
otherwise.
See also the relevant paragraph of (emacs) Text Display
:
Emacs tries to determine if the curved quotes ‘‘’ and ‘’’ can be
displayed on the current display. By default, if this seems to be so,
then Emacs will translate the ASCII quotes (‘`’ and ‘'’), when they
appear in messages and help texts, to these curved quotes. You can
influence or inhibit this translation by customizing the user option
‘text-quoting-style’ (see (elisp)Keys in Documentation).
add a comment |
TL;DR
(setq text-quoting-style 'grave)
Is it possible to have them displayed in their original form?
Yes, see (elisp) Text Quoting Style
, specifically the description of the user option text-quoting-style
:
text-quoting-style is a variable defined in ‘doc.c’.
Its value is nil
Probably introduced at or before Emacs version 25.1.
Documentation:
Style to use for single quotes in help and messages.
Its value should be a symbol. It works by substituting certain single
quotes for grave accent and apostrophe. This is done in help output
(but not for display of Info manuals) and in functions like ‘message’
and ‘format-message’. It is not done in ‘format’.
‘curve’ means quote with curved single quotes ‘like this’.
‘straight’ means quote with straight apostrophes 'like this'.
‘grave’ means quote with grave accent and apostrophe `like this';
i.e., do not alter quote marks. The default value nil acts like
‘curve’ if curved single quotes are displayable, and like ‘grave’
otherwise.
See also the relevant paragraph of (emacs) Text Display
:
Emacs tries to determine if the curved quotes ‘‘’ and ‘’’ can be
displayed on the current display. By default, if this seems to be so,
then Emacs will translate the ASCII quotes (‘`’ and ‘'’), when they
appear in messages and help texts, to these curved quotes. You can
influence or inhibit this translation by customizing the user option
‘text-quoting-style’ (see (elisp)Keys in Documentation).
add a comment |
TL;DR
(setq text-quoting-style 'grave)
Is it possible to have them displayed in their original form?
Yes, see (elisp) Text Quoting Style
, specifically the description of the user option text-quoting-style
:
text-quoting-style is a variable defined in ‘doc.c’.
Its value is nil
Probably introduced at or before Emacs version 25.1.
Documentation:
Style to use for single quotes in help and messages.
Its value should be a symbol. It works by substituting certain single
quotes for grave accent and apostrophe. This is done in help output
(but not for display of Info manuals) and in functions like ‘message’
and ‘format-message’. It is not done in ‘format’.
‘curve’ means quote with curved single quotes ‘like this’.
‘straight’ means quote with straight apostrophes 'like this'.
‘grave’ means quote with grave accent and apostrophe `like this';
i.e., do not alter quote marks. The default value nil acts like
‘curve’ if curved single quotes are displayable, and like ‘grave’
otherwise.
See also the relevant paragraph of (emacs) Text Display
:
Emacs tries to determine if the curved quotes ‘‘’ and ‘’’ can be
displayed on the current display. By default, if this seems to be so,
then Emacs will translate the ASCII quotes (‘`’ and ‘'’), when they
appear in messages and help texts, to these curved quotes. You can
influence or inhibit this translation by customizing the user option
‘text-quoting-style’ (see (elisp)Keys in Documentation).
TL;DR
(setq text-quoting-style 'grave)
Is it possible to have them displayed in their original form?
Yes, see (elisp) Text Quoting Style
, specifically the description of the user option text-quoting-style
:
text-quoting-style is a variable defined in ‘doc.c’.
Its value is nil
Probably introduced at or before Emacs version 25.1.
Documentation:
Style to use for single quotes in help and messages.
Its value should be a symbol. It works by substituting certain single
quotes for grave accent and apostrophe. This is done in help output
(but not for display of Info manuals) and in functions like ‘message’
and ‘format-message’. It is not done in ‘format’.
‘curve’ means quote with curved single quotes ‘like this’.
‘straight’ means quote with straight apostrophes 'like this'.
‘grave’ means quote with grave accent and apostrophe `like this';
i.e., do not alter quote marks. The default value nil acts like
‘curve’ if curved single quotes are displayable, and like ‘grave’
otherwise.
See also the relevant paragraph of (emacs) Text Display
:
Emacs tries to determine if the curved quotes ‘‘’ and ‘’’ can be
displayed on the current display. By default, if this seems to be so,
then Emacs will translate the ASCII quotes (‘`’ and ‘'’), when they
appear in messages and help texts, to these curved quotes. You can
influence or inhibit this translation by customizing the user option
‘text-quoting-style’ (see (elisp)Keys in Documentation).
answered 4 hours ago
BasilBasil
5,791835
5,791835
add a comment |
add a comment |
Basil's answer covers the needs of the end-user.
If you're writing elisp docstrings for other people, however, you (unfortunately) can't rely on everyone configuring text-quoting-style
to grave
, so when you need to ensure that quotes are not converted, you have to use an escaping syntax:
(defun foo ()
"Something about \='foo")
Will ensure that, regardless of text-quoting-style
, the docstring is rendered like so:
Something about 'foo
This is very important if your docstring contains elisp code samples which include quotes, as the default behaviour would render such code invalid (and in a way which might be incredibly difficult for users to discern).
See also Basil's link to (elisp) Text Quoting Style
, which provides another example.
add a comment |
Basil's answer covers the needs of the end-user.
If you're writing elisp docstrings for other people, however, you (unfortunately) can't rely on everyone configuring text-quoting-style
to grave
, so when you need to ensure that quotes are not converted, you have to use an escaping syntax:
(defun foo ()
"Something about \='foo")
Will ensure that, regardless of text-quoting-style
, the docstring is rendered like so:
Something about 'foo
This is very important if your docstring contains elisp code samples which include quotes, as the default behaviour would render such code invalid (and in a way which might be incredibly difficult for users to discern).
See also Basil's link to (elisp) Text Quoting Style
, which provides another example.
add a comment |
Basil's answer covers the needs of the end-user.
If you're writing elisp docstrings for other people, however, you (unfortunately) can't rely on everyone configuring text-quoting-style
to grave
, so when you need to ensure that quotes are not converted, you have to use an escaping syntax:
(defun foo ()
"Something about \='foo")
Will ensure that, regardless of text-quoting-style
, the docstring is rendered like so:
Something about 'foo
This is very important if your docstring contains elisp code samples which include quotes, as the default behaviour would render such code invalid (and in a way which might be incredibly difficult for users to discern).
See also Basil's link to (elisp) Text Quoting Style
, which provides another example.
Basil's answer covers the needs of the end-user.
If you're writing elisp docstrings for other people, however, you (unfortunately) can't rely on everyone configuring text-quoting-style
to grave
, so when you need to ensure that quotes are not converted, you have to use an escaping syntax:
(defun foo ()
"Something about \='foo")
Will ensure that, regardless of text-quoting-style
, the docstring is rendered like so:
Something about 'foo
This is very important if your docstring contains elisp code samples which include quotes, as the default behaviour would render such code invalid (and in a way which might be incredibly difficult for users to discern).
See also Basil's link to (elisp) Text Quoting Style
, which provides another example.
edited 25 mins ago
answered 30 mins ago
philsphils
28.7k23871
28.7k23871
add a comment |
add a comment |
Thanks for contributing an answer to Emacs Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2femacs.stackexchange.com%2fquestions%2f50337%2fdisabling-quote-conversion-in-docstrings%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown