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.

Sign up for GitHub

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

Jump to bottom

Fixes for odoc #1130

Merged
merged 28 commits into from
Apr 15, 2024
Merged

Fixes for odoc #1130

merged 28 commits into from
Apr 15, 2024

Conversation

sim642
Copy link
Contributor

@sim642 sim642 commented Apr 14, 2024 •
edited
Loading

Closes #1093.

make doc already uses odoc and it builds, but with many warnings. This PR fixes a bunch of the fixable ones (there are still all the "unresolvedroot" ones which I'm not sure how should be fixed):

  1. Fix heading levels to start from 1, not 6.
  2. Fix module synopses by separating them with empty lines.
  3. Fix @since and @raise tags.
  4. Replace @added and @obsolete tags with standard @since and @deprecated.
  5. Fix some ambiguous references.

@sim642
Add missing module copy-s to dune
1472ffb
@sim642
Fix ambiguous doc comment in BatRandom
3a9ab0c
@sim642
Disable non-compiling array_filter bench with dune
598aaab
@sim642
Suppress Toploop.directive_table deprecated alert
be298f3
@sim642
Add camlp-streams and str to dune build for OCaml 5 compatibility
b0f0e32
@sim642
Fix bench_int compilation with Stdlib
85dc088
@sim642
Fix dune inline_tests nor preprocessing, adapt conditional $inject-s
2728efe
@sim642
Fix deprecated String.nsplit in BatGc
e88f71b
@sim642
Suppress unused warnings in qtest
cd9b33f
@sim642
Remove $Id comments which confuse qtest
31a966a
@sim642
Split batteries_compattest from dune library
b80bfd3
@sim642
Use test stanza for testsuite
d7a6f86
@sim642
Add title to odoc index
0edb151
@sim642
Remove duplicate title from ocamldoc index
1c4d59a
@sim642
Fix BatSys.backend_type @SInCE
613a438
@sim642
Fix module synopses for odoc
2a0bcee
@sim642
Fix most @raise annotations for odoc
2179c93
@sim642
Fix @SInCE annotations for odoc
d5d3d4a
@sim642
Replace @added and @obsolete tags for odoc
0a8d215
@sim642
Merge branch 'master' into odoc
8196a86
@sim642
Merge branch 'master' into odoc
4009c18
@sim642
Fix heading levels for odoc
9c8b17d
@sim642
Remove empty heading for odoc
e45e8a3
@sim642
Remove spurious markup for odoc
87e5aec
@sim642
Fix ul formatting for odoc
7de4b8e
@sim642
Add BatBytes to documentation index
56b3273
@sim642
Fix ambiguities for odoc
4edcbb7
sim642
sim642 commented Apr 14, 2024
View reviewed changes
src/batChar.mli Outdated Show resolved Hide resolved
@sim642 sim642 marked this pull request as ready for review April 14, 2024 15:09
@UnixJunkie
Copy link
Member

I'll have a look, thanks.

@UnixJunkie UnixJunkie self-assigned this Apr 15, 2024
@UnixJunkie
Copy link
Member

Since it is a large PR, it might take me some time though.
I'll try to do this before the end of the day.

@UnixJunkie
Copy link
Member

Looks good to me.
Thanks for taking care of batteries.
This must have been crazily annoying to fix so many odoc warnings!

@UnixJunkie UnixJunkie merged commit c4dfc61 into ocaml-batteries-team:master Apr 15, 2024
13 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@UnixJunkie UnixJunkie

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Switch to odoc?
2 participants
@sim642 @UnixJunkie