Skip to content

Resolve all Haddock warnings#43

Open
pgujjula wants to merge 5 commits intohaskellari:masterfrom
pgujjula:fix-haddock-links
Open

Resolve all Haddock warnings#43
pgujjula wants to merge 5 commits intohaskellari:masterfrom
pgujjula:fix-haddock-links

Conversation

@pgujjula
Copy link

Resolve all Haddock warnings by fixing broken links and removing links to non-existent values. Also add some minor improvements to documentation.

{-# INLINE ifor_ #-}

-- | Run monadic actions for each target of an 'IndexedFold' or 'Control.Lens.IndexedTraversal.IndexedTraversal' with access to the index,
-- | Run monadic actions for each target of an 'ControlLens.Fold.IndexedFold' or 'Control.Lens.IndexedTraversal.IndexedTraversal' with
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aren't these new links broken too, as there is no dependency on lens anywhere near?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you're right, there's no warning emitted by Haddock but the links are broken. I'll rewrite this to remove references to lens.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rewrote that documentation to remove the references to lens.

I also fixed another warning emitted by Haddock 2.30.0 by disambiguating type/constructor puns (previously I was testing with Haddock 2.29.2)

pgujjula added 2 commits May 17, 2024 14:42
Haddocks previously referred to Identity/Compose types in a location
where they should have referred to their constructors instead.
@pgujjula
Copy link
Author

Do these changes look good now @phadej?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants