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

Speed up this NIntegrate

Madam I m Adam..please don’t get mad..you will no longer be prime

Is there a proof that the set of real numbers can exactly represent distances?

Is there a word that describes the unjustified use of a more complex word?

Looking for sci-fi book based on Hinduism/Buddhism

How do I, as a DM, handle a party that decides to set up an ambush in a dungeon?

All superlinear runtime algorithms are asymptotically equivalent to convex function?

Sci-fi/fantasy book - ships on steel runners skating across ice sheets

All of my Firefox add-ons been disabled suddenly, how can I re-enable them?

What Kind of Wooden Beam is this

Make me a minimum magic sum

Why does sound not move through a wall?

Disabling quote conversion in docstrings

Motion-trail-like lines

How can I get people to remember my character's gender?

How to preserve a rare version of a book?

Find the limit or prove that it does not exist

How did the Apollo guidance computer handle parity bit errors?

As a GM, is it bad form to ask for a moment to think when improvising?

In linear regression why does regularisation penalise the parameter values as well?

Would a "Permanence" spell in 5e be overpowered?

Why is my arithmetic with a long long int behaving this way?

What do you call a painting on a wall?

Drawing an hexagonal cone in TikZ 2D



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













2















(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?










share|improve this question




























    2















    (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?










    share|improve this question


























      2












      2








      2








      (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?










      share|improve this question
















      (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






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited 1 hour ago









      Drew

      49.6k463108




      49.6k463108










      asked 5 hours ago









      ToothrotToothrot

      914412




      914412




















          2 Answers
          2






          active

          oldest

          votes


















          2














          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).





          share|improve this answer






























            1














            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.






            share|improve this answer

























              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
              );



              );













              draft saved

              draft discarded


















              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









              2














              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).





              share|improve this answer



























                2














                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).





                share|improve this answer

























                  2












                  2








                  2







                  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).





                  share|improve this answer













                  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).






                  share|improve this answer












                  share|improve this answer



                  share|improve this answer










                  answered 4 hours ago









                  BasilBasil

                  5,791835




                  5,791835





















                      1














                      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.






                      share|improve this answer





























                        1














                        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.






                        share|improve this answer



























                          1












                          1








                          1







                          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.






                          share|improve this answer















                          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.







                          share|improve this answer














                          share|improve this answer



                          share|improve this answer








                          edited 1 hour ago

























                          answered 1 hour ago









                          philsphils

                          28.7k23871




                          28.7k23871



























                              draft saved

                              draft discarded
















































                              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.




                              draft saved


                              draft discarded














                              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





















































                              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







                              Popular posts from this blog

                              Canceling a color specificationRandomly assigning color to Graphics3D objects?Default color for Filling in Mathematica 9Coloring specific elements of sets with a prime modified order in an array plotHow to pick a color differing significantly from the colors already in a given color list?Detection of the text colorColor numbers based on their valueCan color schemes for use with ColorData include opacity specification?My dynamic color schemes

                              Invision Community Contents History See also References External links Navigation menuProprietaryinvisioncommunity.comIPS Community ForumsIPS Community Forumsthis blog entry"License Changes, IP.Board 3.4, and the Future""Interview -- Matt Mecham of Ibforums""CEO Invision Power Board, Matt Mecham Is a Liar, Thief!"IPB License Explanation 1.3, 1.3.1, 2.0, and 2.1ArchivedSecurity Fixes, Updates And Enhancements For IPB 1.3.1Archived"New Demo Accounts - Invision Power Services"the original"New Default Skin"the original"Invision Power Board 3.0.0 and Applications Released"the original"Archived copy"the original"Perpetual licenses being done away with""Release Notes - Invision Power Services""Introducing: IPS Community Suite 4!"Invision Community Release Notes

                              199年 目錄 大件事 到箇年出世嗰人 到箇年死嗰人 節慶、風俗習慣 導覽選單