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













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 50 mins 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






























            0














            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





















                      0














                      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





























                        0














                        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



























                          0












                          0








                          0







                          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 25 mins ago

























                          answered 30 mins 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

                              Log på Navigationsmenu

                              Creating second map without labels using QGIS?How to lock map labels for inset map in Print Composer?How to Force the Showing of Labels of a Vector File in QGISQGIS Valmiera, Labels only show for part of polygonsRemoving duplicate point labels in QGISLabeling every feature using QGIS?Show labels for point features outside map canvasAbbreviate Road Labels in QGIS only when requiredExporting map from composer in QGIS - text labels have moved in output?How to make sure labels in qgis turn up in layout map?Writing label expression with ArcMap and If then Statement?

                              Nuuk Indholdsfortegnelse Etyomologi | Historie | Geografi | Transport og infrastruktur | Politik og administration | Uddannelsesinstitutioner | Kultur | Venskabsbyer | Noter | Eksterne henvisninger | Se også | Navigationsmenuwww.sermersooq.gl64°10′N 51°45′V / 64.167°N 51.750°V / 64.167; -51.75064°10′N 51°45′V / 64.167°N 51.750°V / 64.167; -51.750DMI - KlimanormalerSalmonsen, s. 850Grønlands Naturinstitut undersøger rensdyr i Akia og Maniitsoq foråret 2008Grønlands NaturinstitutNy vej til Qinngorput indviet i dagAntallet af biler i Nuuk må begrænsesNy taxacentral mødt med demonstrationKøreplan. Rute 1, 2 og 3SnescootersporNuukNord er for storSkoler i Kommuneqarfik SermersooqAtuarfik Samuel KleinschmidtKangillinguit AtuarfiatNuussuup AtuarfiaNuuk Internationale FriskoleIlinniarfissuaq, Grønlands SeminariumLedelseÅrsberetning for 2008Kunst og arkitekturÅrsberetning for 2008Julie om naturenNuuk KunstmuseumSilamiutGrønlands Nationalmuseum og ArkivStatistisk ÅrbogGrønlands LandsbibliotekStore koncerter på stribeVandhund nummer 1.000.000Kommuneqarfik Sermersooq – MalikForsidenVenskabsbyerLyngby-Taarbæk i GrønlandArctic Business NetworkWinter Cities 2008 i NuukDagligt opdaterede satellitbilleder fra NuukområdetKommuneqarfik Sermersooqs hjemmesideTurist i NuukGrønlands Statistiks databankGrønlands Hjemmestyres valgresultaterrrWorldCat124325457671310-5