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

search friendly html document by removing <span>s #104

Open
arbipher opened this issue Dec 8, 2020 · 1 comment
Open

search friendly html document by removing <span>s #104

arbipher opened this issue Dec 8, 2020 · 1 comment
Labels
forwarded-to-js-devs This report has been forwarded to Jane Street's internal review system.

Comments

@arbipher
Copy link

arbipher commented Dec 8, 2020

It may be the case for non-expert users to search for a type to check whether some standard function exist,
e.g. I searched 'a -> 'a -> 'a in the List module to check how many variants of List.reduce and pick one.

However, the current generated HTML doesn't support a naive search of type string like 'a -> 'a -> 'a. The reason is there are some <span> in it to prevent web browser in page search to find it easilly.

<span>(<span class="type-var">'a</span> <span>-&gt;</span> <span class="type-var">'a</span> <span>-&gt;</span> <span class="type-var">'a</span>)</span>

I can search 'a -> 'a -> 'a in the source code.

I suggest removing some spans in the output to make it friendly to naive in-page search.

@github-iron github-iron added the forwarded-to-js-devs This report has been forwarded to Jane Street's internal review system. label Dec 9, 2020
@lpw25
Copy link
Member

lpw25 commented Dec 11, 2020

The problem seems to be related to our css rather than the spans themselves. Our internal docs site uses different css and doesn't suffer from this problem. We're intending to switch our external documentation to the same css as our internal site at our next release, so this should be resolved when that happens.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
forwarded-to-js-devs This report has been forwarded to Jane Street's internal review system.
Projects
None yet
Development

No branches or pull requests

3 participants