Resolve all Haddock warnings #43
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix a typo and add a missing module description.
phadej
reviewed
May 17, 2024
| -- @ | ||
| ifor_ :: (FoldableWithIndex i t, Applicative f) => t a -> (i -> a -> f b) -> f () | ||
| ifor_ = flip itraverse_ | ||
| {-# 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 |
There was a problem hiding this comment.
Aren't these new links broken too, as there is no dependency on lens anywhere near?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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)
Haddocks previously referred to Identity/Compose types in a location where they should have referred to their constructors instead.
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolve all Haddock warnings by fixing broken links and removing links to non-existent values. Also add some minor improvements to documentation.