ivan-m / graphviz

Haskell bindings to the Graphviz toolkit
Other
64 stars 24 forks source link

Typo in Newline docs #51

Open georgefst opened 4 years ago

georgefst commented 4 years ago

Here.

I'm guessing perhaps the first occurrence of Attribute should say Align?

kukimik commented 2 years ago

It looks good in my local build of the docs (with haddock 2.23.0). There are however some warnings in the haddock output, like:

Warning: 'Align' is ambiguous. It is defined
    * at Data/GraphViz/Attributes/HTML.hs:311:18
    * at Data/GraphViz/Attributes/HTML.hs:446:1
    You may be able to disambiguate the identifier by qualifying it or
    by specifying the type/value namespace explicitly.
    Defaulting to the one defined at Data/GraphViz/Attributes/HTML.hs:446:1

One can fix these warnings by specifying the namespace (added the v in v'Align'), see this recent blog post:

-- | Textual items in HTML-like labels.
data TextItem = Str T.Text
                -- | Only accepts an optional v'Align'
                --   'Attribute'; defined this way for ease of
                --   printing/parsing.
              | Newline Attributes
              | Font Attributes Text
                -- | Only available in Graphviz >= 2.28.0.
              | Format Format Text
              deriving (Eq, Ord, Show, Read)

However, I don't know which version of haddock is used for building the docs on Hackage (and don't know how to check this). Probably it's some version earlier than 2.23.0, hence the error. And unfortunately this would mean the fix does not apply, since specifying the namespace is available since haddock-2.23.0.