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
Record fields and constructor are linkable. #506
Comments
…ocaml#505, ocaml#506) Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
I'm not sure I understand this issue (and I'm not fluent enough in CSS to understand its fix). |
Ah! Probably I missed the rationale of them being linkable, could you please explain why? |
Err, nothing in particular, it's just useful to be able to refer to them, in the same way that it's useful to refer to any other item in the page. |
Because they're not referenced anywhere, except to themselves, however, to me, the need for them could be when sharing the link with another party, which I find reasonable to share the link to the type declaration in which they're difined, rather than individual fields or constructors. |
As @trefis said, this is intentional. In general, odoc's credo when it comes to these things is: "Everything that can possibly be linkified should be". This comes from a lot of experience with ocamldoc where people complained not being able to give links to every imaginable pieces of documentation. In any case, this doesn't hurt anyone. :) |
Cool, I can revert that change. I was just curious to know why they had to be linkable, rather than against the other's opinion. |
Record
fields andconstructors
show#
when hovering over them, thus become linkable.The text was updated successfully, but these errors were encountered: