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

Remove unnecessary @inlines (when an odoc bug is fixed) #198

Open
Tracked by #83
NatKarmios opened this issue Dec 13, 2022 · 0 comments
Open
Tracked by #83

Remove unnecessary @inlines (when an odoc bug is fixed) #198

NatKarmios opened this issue Dec 13, 2022 · 0 comments
Assignees
Labels
cleanup documentation Improvements or additions to documentation

Comments

@NatKarmios
Copy link
Contributor

NatKarmios commented Dec 13, 2022

Odoc currently has a bug with nested @canonical tags (discussed in this conversation in the OCaml Discord server); in order to get the desired output in documentation, I've had to use some module @includes that aren't the cleanest.

For example, this is the contents of Debugger_lifter.ml:

(** @canonical Gillian.Debugger.Lifter

  The mechanism for lifting execution of GIL commands to a target language. *)

include Lifter

module Gil_lifter = struct
  (** @inline*)
  include Gil_lifter
end

module Gil_fallback_lifter = struct
  (** @inline *)
  include Gil_fallback_lifter
end
@NatKarmios NatKarmios added documentation Improvements or additions to documentation cleanup labels Dec 13, 2022
@NatKarmios NatKarmios self-assigned this Dec 13, 2022
@NatKarmios NatKarmios changed the title Remove unnecessary @includes (when an odoc bug is fixed) Remove unnecessary @inlines (when an odoc bug is fixed) Feb 23, 2023
@NatKarmios NatKarmios mentioned this issue Feb 23, 2023
54 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant