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

Fallback to ocaml.org documentation page #1331

Merged
merged 3 commits into from
Mar 12, 2024
Merged

Conversation

tatchi
Copy link
Collaborator

@tatchi tatchi commented Jan 5, 2024

Fallback to the ocaml.org package documentation page if there is no doc field in the package's opam file. Note that it doesn't currently check whether the page exists on ocaml.org, so it may return a 404 error.

Screen.Recording.2024-01-05.at.16.52.32.mov

@tatchi tatchi requested a review from smorimoto January 5, 2024 15:57
@tatchi
Copy link
Collaborator Author

tatchi commented Jan 5, 2024

cc @sabine does it sound like a reasonable idea?

src/treeview_sandbox.ml Outdated Show resolved Hide resolved
src/treeview_switches.ml Outdated Show resolved Hide resolved
@smorimoto
Copy link
Collaborator

This PR also needs a change log entry!

@rgrinberg
Copy link
Contributor

@tmattio do you have some feedback on this one?

@smorimoto
Copy link
Collaborator

Do you have any ideas about this? @sabine @tmattio

@smorimoto
Copy link
Collaborator

@tatchi Could you add a change log entry?

@sabine
Copy link

sabine commented Mar 8, 2024

These URLs are stable, so linking to them is fine. Sure, we can't guarantee the docs built on OCaml.org, but since it's a fallback that should be fine! @smorimoto

@smorimoto
Copy link
Collaborator

Thanks 🙌

@tatchi
Copy link
Collaborator Author

tatchi commented Mar 11, 2024

@tatchi Could you add a change log entry?

done (sorry for the delay)

@tatchi tatchi requested a review from smorimoto March 11, 2024 14:32
@smorimoto smorimoto merged commit ede23b4 into master Mar 12, 2024
7 checks passed
@smorimoto smorimoto deleted the doc-fallback-to-ocamlorg branch March 12, 2024 14:35
@smorimoto smorimoto changed the title fallback to ocaml.org documentation page Fallback to ocaml.org documentation page Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants