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

Record fields and constructor are linkable. #506

Closed
lubegasimon opened this issue Oct 16, 2020 · 6 comments
Closed

Record fields and constructor are linkable. #506

lubegasimon opened this issue Oct 16, 2020 · 6 comments

Comments

@lubegasimon
Copy link
Collaborator

lubegasimon commented Oct 16, 2020

Record fields and constructors show # when hovering over them, thus become linkable.

Screenshot 2020-10-14 at 22 41 46

lubegasimon added a commit to lubegasimon/odoc that referenced this issue Oct 16, 2020
@trefis
Copy link
Contributor

trefis commented Oct 16, 2020

I'm not sure I understand this issue (and I'm not fluent enough in CSS to understand its fix).
But fields and constructors are linkable on purpose, so I'm not sure what the issue is (apart that the rendering is a bit ugly).

@lubegasimon
Copy link
Collaborator Author

But fields and constructors are linkable on purpose

Ah! Probably I missed the rationale of them being linkable, could you please explain why?

@trefis
Copy link
Contributor

trefis commented Oct 16, 2020

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.
Why shouldn't they be linkable?

@lubegasimon
Copy link
Collaborator Author

Why shouldn't they be linkable?

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.

@Drup
Copy link
Contributor

Drup commented Oct 16, 2020

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. :)

@lubegasimon
Copy link
Collaborator Author

lubegasimon commented Oct 16, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants