Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Haddock module attributes specified with old syntax #1153

Merged
merged 1 commit into from

2 participants

@bmillwood

Several modules specify the Haddock hide attribute, but with the old, pre-Haddock-2 syntax.

Attached is a commit to just blindly swap all the old syntax with the new syntax.

However, I suggest we think a bit about whether or not the modules ought to have been hidden, whether or not they should continue to be hidden, and whether or not anything else should be hidden. If we decide anything other than the obvious, I'm happy to close this pull request and formulate a new one.

See also this SO question – some of the hide options are on modules which aren't exported, and hence are probably redundant.

@bmillwood bmillwood Update syntax of Haddock module attributes
This re-hides several modules that had been inadvertently unhidden by
the change in attribute syntax in Haddock 2.0.0.0 (nearly five years
ago!)
47cd57c
@bmillwood

(Consequence of odd rebases: the above commit is older than its parents)

@23Skidoo
Collaborator

Looks fairly benign, so I'm merging this in. If anyone has objections, please revert.

@23Skidoo 23Skidoo merged commit 0b371b5 into from
@bmillwood bmillwood deleted the branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 2, 2013
  1. @bmillwood

    Update syntax of Haddock module attributes

    bmillwood authored
    This re-hides several modules that had been inadvertently unhidden by
    the change in attribute syntax in Haddock 2.0.0.0 (nearly five years
    ago!)
This page is out of date. Refresh to see the latest.
View
2  Cabal/Distribution/Compat/CopyFile.hs
@@ -4,7 +4,7 @@
{-# OPTIONS_GHC -cpp #-}
{-# OPTIONS_NHC98 -cpp #-}
{-# OPTIONS_JHC -fcpp #-}
--- #hide
+{-# OPTIONS_HADDOCK hide #-}
module Distribution.Compat.CopyFile (
copyFile,
copyOrdinaryFile,
View
2  Cabal/Distribution/Compat/TempFile.hs
@@ -4,7 +4,7 @@
{-# OPTIONS_GHC -cpp #-}
{-# OPTIONS_NHC98 -cpp #-}
{-# OPTIONS_JHC -fcpp #-}
--- #hide
+{-# OPTIONS_HADDOCK hide #-}
module Distribution.Compat.TempFile (
openTempFile,
openBinaryTempFile,
View
2  Cabal/Distribution/GetOpt.hs
@@ -36,7 +36,7 @@ over 1100 lines, we need only 195 here, including a 46 line example!
:-)
-}
--- #hide
+{-# OPTIONS_HADDOCK hide #-}
module Distribution.GetOpt (
-- * GetOpt
getOpt, getOpt',
View
2  Cabal/Distribution/ParseUtils.hs
@@ -47,7 +47,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}
-- This module is meant to be local-only to Distribution...
--- #hide
+{-# OPTIONS_HADDOCK hide #-}
module Distribution.ParseUtils (
LineNo, PError(..), PWarning(..), locatedErrorMsg, syntaxError, warning,
runP, runE, ParseResult(..), catchParseError, parseFail, showPWarning,
Something went wrong with that request. Please try again.