-
Notifications
You must be signed in to change notification settings - Fork 96
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
Exceptions problem + general structure of definitions + link structure #23
Comments
(Also I think it would be easier to hack urls if |
The exception was indeed completely wrong and has been fixed. |
This looks ok except I suggest suggest that for |
I also notice that the strings |
There are still a few ugly points in the code, but the produced html should now be correct. So I think we can say this commit - fixes ocaml/odoc#23 - fixes ocaml/odoc#25
Exceptions are not well marked up. See for example http://docs.mirage.io/odoc/alcotest/Alcotest/index.html
<div class="region">
block but in a<div class="exn">
.exception
notexn
.Related to the general structure #18 and #19 I would prefer if we drop the
region
class. I think each definition should be marked up as follows:Where
$(KIND)
is the kind of construct.spec
comes from the vocabulary of the module system.Regarding anchor fragments I find
#/$(ID).$(kind)
to be noisy in practice. In the above proposal I dropped the/
and also reversed the$(KIND)
and$(ID)
as it then matches the order we write them in OCaml. Replaced the.
by-
to avoid confusion with OCaml paths.The text was updated successfully, but these errors were encountered: