Replace fragile GHC manual section references by urls #1072

Merged
merged 1 commit into from Oct 18, 2012

Projects

None yet

2 participants

@hvr
Member
hvr commented Oct 18, 2012

This replaces the GHC/Hugs manual references in the Haddock comments
for the Language.Haskell.Extension.Extension enum constructors, as
in

  -- | [GHC § 7.6.3.4] Allow overlapping class instances,
  -- provided there is a unique most specific instance for each use.
  OverlappingInstances

which urls pointing directly to the section containing further
documentation (assuming the urls are more immune to section
reorderings), e.g.:

  -- | Allow overlapping class instances, provided there is a unique
  -- most specific instance for each use.
  --
  -- * <http://www.haskell.org/ghc/docs/latest/html/users_guide/type-class-extensions.html#instance-overlap>
     OverlappingInstances
@hvr hvr Replace fragile GHC manual section references by urls
This replaces the GHC/Hugs manual references in the Haddock comments
for the `Language.Haskell.Extension.Extension` enum constructors, as
in

```haskell
  -- | [GHC &#xa7; 7.6.3.4] Allow overlapping class instances,
  -- provided there is a unique most specific instance for each use.
  OverlappingInstances
```

which urls pointing directly to the section containing further
documentation (assuming the urls are more immune to section
reorderings), e.g.:

```haskell
  -- | Allow overlapping class instances, provided there is a unique
  -- most specific instance for each use.
  --
  -- * <http://www.haskell.org/ghc/docs/latest/html/users_guide/type-class-extensions.html#instance-overlap>
     OverlappingInstances
```
0457137
@dcoutts

Great!

@dcoutts dcoutts merged commit 7b0c2ce into haskell:master Oct 18, 2012
@hvr hvr deleted the hvr:lang-ext branch Mar 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment