Re: [GHC] #11002: man page incomplete sentences (was: man page has incomplete sentences)

22 Oct 2015

      #11002: man page incomplete sentences
-------------------------------------+-------------------------------------
        Reporter:  osa1              |                Owner:
            Type:  bug               |               Status:  new
        Priority:  low               |            Milestone:
       Component:  Documentation     |              Version:  7.10.2
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
                                     |  Unknown/Multiple
 Type of failure:  None/Unknown      |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Old description:
...
man page has multiple entries like this:
{{{
... Interactive mode - normally used by just running ghci; see for
details.
... be much easier, and faster, than using make; see for details..
... Evaluate expr; see for details.
}}}
`see ... for details` the dotted part is missing. Probably a bug in the
man page generator?
New description:

 man page multiple entries like this:

 {{{
               Interactive mode - normally used by just running ghci; see
 for details.

               be much easier, and faster, than using make; see for
 details..

               Evaluate expr; see for details.

 }}}

 `see ... for details` the dotted part is missing. Probably a bug in the
 man page generator?

--

Comment (by bgamari):

 What Sphinx version are you using? I'm afraid I can't reproduce this with
 1.3.1. I see this,
 {{{
    Modes of operation
        --help,-?
               Display help

        --interactive
               Interactive mode - normally used by just running ghci; see
 ghci for details.

        --make Build a multi-module Haskell program, automatically figuring
 out dependencies. Likely to be much easier, and faster, than using make;
 see make-mode for details.
 }}}

 The links (e.g. `ghci` and `make-mode`) obviously aren't hyperlinks
 although I'm not entirely sure how to fix this given that man doesn't
 support arbitrary hyperlinks.

 Ideally Sphinx would transform these into somethink like "see the GHCi
 section of the Users' Guide for details." but this is clearly expecting a
 lot.

--
Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11002#comment:3
GHC http://www.haskell.org/ghc/
The Glasgow Haskell Compiler