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

Provide a Complete Module Index #1022

Open
sabine opened this issue Oct 17, 2023 · 3 comments
Open

Provide a Complete Module Index #1022

sabine opened this issue Oct 17, 2023 · 3 comments

Comments

@sabine
Copy link

sabine commented Oct 17, 2023

One recurring feature request we get for OCaml.org is the wish to have a full index (which we would use on to the left navigation on the ocaml.org package documentation) that includes all the definitions within the modules / classes / etc.

I think it's a valid request that also enables a diff of the module index between package versions.

@Julow
Copy link
Collaborator

Julow commented Jan 22, 2024

We have plans to improve the navigation side bar in the future (though not concrete enough yet) that would include listing submodules and siblings modules. It would hopefully be good enough for ocaml.org.
Do you also plan to generate a page listing all the definitions ?

@panglesd Do you think the work on occurrence counting could help list the definitions ?

@sabine
Copy link
Author

sabine commented Jan 22, 2024

We have plans to improve the navigation side bar in the future (though not concrete enough yet) that would include listing submodules and siblings modules. It would hopefully be good enough for ocaml.org. Do you also plan to generate a page listing all the definitions ?

Just putting this here so it's not forgotten. No concrete plans to do this right now.

A thing we can do with a complete index is to compute diffs between two package versions to know when a given value has been added or removed between versions.

@panglesd
Copy link
Collaborator

@panglesd Do you think the work on occurrence counting could help list the definitions ?

The occurrence command list the occurrences as found in the implementation files. If no occurrence is found, the table won't include the definition.

Maybe the index for search entries could be used instead...

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