Skip to content

Commit 3e332c9

Browse files
committed
Impl generation: review comments
1 parent 82c5e10 commit 3e332c9

File tree

3 files changed

+4
-20
lines changed

3 files changed

+4
-20
lines changed

CHANGES.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
`count-occurrences` flag and command to count occurrences of every identifiers
77
(@panglesd, #976)
88
- Separate compilation of interface and implementation files, using a new
9-
`compile-src` command (@panglesd, #1067).
9+
`compile-src` command (@panglesd, #1067, #1188).
1010
- Add clock emoji before `@since` tag (@yawaramin, #1089)
1111
- Navigation for the search bar : use '/' to enter search, up and down arrows to
1212
select a result, and enter to follow the selected link. (@EmileTrotignon, #1088)
@@ -26,7 +26,6 @@
2626
(@panglesd, #1076).
2727
- Added a `compile-asset` command (@EmileTrotignon, @panglesd, #1170)
2828
- Allow referencing assets (@panglesd, #1171)
29-
- Clean up CLI API for implementations (@panglesd, #1188)
3029

3130
### Changed
3231

src/odoc/bin/main.ml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -863,7 +863,7 @@ end = struct
863863
let generate ~docs = Generate.(cmd, info ~docs)
864864

865865
module Generate_source = struct
866-
let generate extra _hidden output_dir syntax extra_suffix input_file
866+
let generate extra output_dir syntax extra_suffix input_file
867867
warnings_options source_file =
868868
Rendering.generate_source_odoc ~renderer:R.renderer ~warnings_options
869869
~syntax ~output:output_dir ~extra_suffix ~source_file extra input_file
@@ -873,7 +873,7 @@ end = struct
873873
Arg.(
874874
required
875875
& opt (some convert_fpath) None
876-
& info [ "impl" ] ~doc ~docv:"impl-file.odocl")
876+
& info [ "impl" ] ~doc ~docv:"impl-FILE.odocl")
877877

878878
let source_file =
879879
let doc = "Source code for the implementation unit." in
@@ -893,7 +893,7 @@ end = struct
893893
in
894894
Term.(
895895
const handle_error
896-
$ (const generate $ R.extra_args $ hidden $ dst ~create:true () $ syntax
896+
$ (const generate $ R.extra_args $ dst ~create:true () $ syntax
897897
$ extra_suffix $ input_odocl $ warnings_options $ source_file))
898898

899899
let info ~docs =

src/odoc/rendering.ml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -165,18 +165,3 @@ let targets_source_odoc ~syntax ~warnings_options ~renderer ~output:root_dir
165165
Ok ()
166166
| Page_content _ | Unit_content _ | Asset_content _ ->
167167
Error (`Msg "Expected an implementation unit")
168-
(* let docs = *)
169-
(* if Fpath.get_ext odoctree = ".odoc" then *)
170-
(* documents_of_input ~renderer ~extra ~resolver ~warnings_options ~syntax *)
171-
(* odoctree *)
172-
(* else documents_of_odocl ~warnings_options ~renderer ~extra ~syntax odoctree *)
173-
(* in *)
174-
(* docs >>= fun docs -> *)
175-
(* List.iter *)
176-
(* (fun doc -> *)
177-
(* let pages = renderer.Renderer.render extra None doc in *)
178-
(* Renderer.traverse pages ~f:(fun filename _content -> *)
179-
(* let filename = Fpath.normalize @@ Fs.File.append root_dir filename in *)
180-
(* Format.printf "%a\n" Fpath.pp filename)) *)
181-
(* docs; *)
182-
(* Ok () *)

0 commit comments

Comments
 (0)