[GHC] #14023: Split up glasgow_exts.rst
#14023: Split up glasgow_exts.rst -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: task | Status: new Priority: normal | Milestone: 8.4.1 Component: Documentation | Version: 8.0.1 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: None/Unknown Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- The `docs/users-guide/glasgow_exts.rst` is crazy large. This makes it difficult to navigate both while editing and reading. It should probably be split up into multiple files along the top-level headings. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14023 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#14023: Split up glasgow_exts.rst -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: task | Status: new Priority: normal | Milestone: 8.6.1 Component: Documentation | Version: 8.0.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * keywords: => newcomers -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14023#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#14023: Split up glasgow_exts.rst -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: task | Status: new Priority: normal | Milestone: 8.8.1 Component: Documentation | Version: 8.0.1 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * keywords: newcomers => newcomer * milestone: 8.6.1 => 8.8.1 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14023#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#14023: Split up glasgow_exts.rst -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: task | Status: new Priority: normal | Milestone: 8.8.1 Component: Documentation | Version: 8.0.1 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by AntC): I support splitting up the file: It is nerve-wracking to edit it for fear of mucking up a section you never intended to touch. Previewing it to see your edits takes a long wait for rendering. And it's too easy to mess up the formatting with result that the contents/index turns to custard. OTOH there are many cross-references amongst different subsections. Is `.rst` clever enought to stitch togethere the labels? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14023#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#14023: Split up glasgow_exts.rst -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: task | Status: new Priority: normal | Milestone: 8.8.1 Component: Documentation | Version: 8.0.1 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari):
OTOH there are many cross-references amongst different subsections. Is .rst clever enought to stitch togethere the labels?
Indeed it is (assuming the reference is a `:ref:`).
I support splitting up the file:
I would love to see this done. My only concern is that we may end up breaking users guide URLs again. That being said, `glasgow_exts` is getting a bit unwieldy so perhaps this is a worthwhile cost to bear. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14023#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC