Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix (some) odoc warnings #53

Merged
merged 4 commits into from
Jan 7, 2025
Merged

Conversation

mbarbin
Copy link
Contributor

@mbarbin mbarbin commented Jan 5, 2025

I noticed a number of warnings when building the doc target locally and thought I would attempt to look into it.

As it turns out, most warnings of the unresolvedroot kind look like bugs. For example:

File "lib/miou.mli", line 899, characters 4-57:
Warning: Failed to resolve reference unresolvedroot(Invalid_argument) Couldn't find "Invalid_argument"

Instead of pursuing those, I switched to compiling the doc-new target instead, which I presume, by bringing external dependencies into the scope, resolves these kinds of warnings. I then focused on fixing the remaining warnings only.

There remain 2 at the tip of the PR, but I believe they come from external dependencies, so there's no point in trying to solve them here.

$ dune build @doc-new
File "src/fmt_cli.mli", line 6, characters 4-15:
Warning: Failed to resolve reference unresolvedroot(Cmdliner) Couldn't find "Cmdliner"
File "src/fmt.mli", line 6, characters 4-13:
Warning: Failed to resolve reference unresolvedroot(Format) Couldn't find "Format"

@dinosaure
Copy link
Contributor

I rebased your PR. Seems ok me, let's see the CI and I will waiting to see this PR as ready 👍.

lib/miou.mli Show resolved Hide resolved
@mbarbin mbarbin marked this pull request as ready for review January 7, 2025 19:25
@mbarbin
Copy link
Contributor Author

mbarbin commented Jan 7, 2025

I enabled for review, modulo just 2 simple remarks, which I just added a review comment. If you are happy with it, I am too. Thanks for looking into the PR!

@dinosaure
Copy link
Contributor

Ok the PR is ready merge, let's go 👍.

@dinosaure dinosaure merged commit c997056 into robur-coop:main Jan 7, 2025
1 check passed
@mbarbin mbarbin deleted the fix-odoc-warnings branch January 7, 2025 19:53
dinosaure added a commit to dinosaure/opam-repository that referenced this pull request Jan 13, 2025
CHANGES:

- Notice the domain if it needs to look into the shared heap if a task is ready
  to be transfered (@dinosaure, robur-coop/miou#41)
- Don't use `Option.value` but `match .. with` to calculate the optional length
  for `Miou_unix.{read,write}` (@kit-ty-kate, robur-coop/miou#44)
- Use `List.iter` instead of `Hashtbl.iter` for internal kept file-descriptors
  of `Miou_unix` (@dinosaure, robur-coop/miou#45)
- Improve the documentation of `Miou_unix` about suspended syscalls (@dinosaure,
  @kit-ty-kate, robur-coop/miou#43)
- Export `reraise` (@dinosaure, robur-coop/miou#46)
- Fix an issue on the `dom0` and observe if some tasks must be transfered to it
  (@dinosaure, robur-coop/miou#48)
- Fix documentation (@mbarbin, robur-coop/miou#47)
- Fix the formatter (@mbarbin, robur-coop/miou#51)
- Upgrade miou to `ocamlformat.0.27.0` (@mbarbin, robur-coop/miou#52)
- Add `x-maintenance-intent` (@hannesm, robur-coop/miou#56)
- Improve the documentation and some `odoc` warnings (@mbarbin, robur-coop/miou#53, robur-coop/miou#54)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants