Enable sherlodoc on .odoc-index file for odoc 3 compat #42
Conversation
index/index.ml
Outdated
| @@ -55,24 +74,50 @@ let main | |||
| close_in h ; | |||
| files @ other_files | |||
| in | |||
| let files = List.map Fpath.v files in | |||
| let favourite_files = List.map Fpath.v favourite_files in | |||
There was a problem hiding this comment.
Should we be using Fpath.of_string? (as the doc mentions it's better for untrusted inputs)
There was a problem hiding this comment.
It seems to me that of_string return the same error but in a result instead of an exception. Here, if we got an invalid path I think we would crash, so I think v is fine.
We might want to switch to of_string if we wanted to have a warning instead of a crash of invalid paths.
index/index.ml
Outdated
| let h = Storage.open_out db_filename in | ||
| let flush () = | ||
| let t = Db_writer.export ~summarize:(db_format = `ancient) db in | ||
| Storage.save ~db:h t | ||
| in | ||
| let loop ~favourite odoc = | ||
| let loop kind ~favourite file = | ||
| let odoc = Fpath.to_string file in | ||
| let pkg, odoc = | ||
| match String.split_on_char '\t' odoc with |
There was a problem hiding this comment.
It looks very weird that we are parsing a tab-separated format from the odoc variable that was previously treated as a valid filename... Maybe it would be easier to check if the filename is an .odocl or .odoc-index on line 71 below, instead of doing a bunch of List.filter above? :)
There was a problem hiding this comment.
You're right thats quite weird
|
Would it be possible to add a little test to generate an |
|
The CI seems to report errors with the latest odoc CLI which I'm not familiar with... Any ideas on how to update the cram tests? :) |
|
If I understand correctly the CI uses regular odoc, instead of the latest version from master. The corresponding PR in odoc is merged, so a pin on master should fix this. |
|
I have updated this to work with the latest odoc |
This adds support for the future odoc 3, which include generating .odoc-index files for sherlodoc to consume instead of consuming .odocl files directly.
It works with the following odoc PR : ocaml/odoc#1084