Add occurrence count in the json output for search engine #1076
Conversation
|
Note that there will be a conflict with #1067 which we will need to resolve (in whichever PR gets merged last). |
Signed-off-by: Paul-Elliot <[email protected]>
src/search/json_index/json_search.ml
Outdated
| ("direct", `Float (float_of_int occ.Odoc_occurrences.Table.direct)); | ||
| ("indirect", `Float (float_of_int occ.indirect)); | ||
| ] | ||
| | None -> `Null |
There was a problem hiding this comment.
Nit-picking but it would look more consistent to me if we had 0 for both counters here (see the output in the tests).
There was a problem hiding this comment.
What about "no 'occurrences' field at all"?
I'm not very keen on choosing a wrong value when it was not possible to compute one because the table was not given...
There was a problem hiding this comment.
Well, at least if we don't put this field at all it reduces the diff of this PR!
There was a problem hiding this comment.
With 6205f97, if the occurrence table is not given, the field is not included.
However, if the occurrence table is given, but does not contain the occurrence, a use of 0 is counted.
Indeed, that removed that the diff for search without occurrences.
Thanks for the comment, I think that's better now!
Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
occurrences-in-index
branch
from
6205f97
to
69306f6
Compare
|
What's the status of this ? |
|
It was ready for review. Now there are many conflicting files. |
Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
occurrences-in-index
branch
from
822c54a
to
1b71952
Compare
Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
occurrences-in-index
branch
from
1b71952
to
fd15b16
Compare
|
It is now rebased and ready for review. |
src/search/json_index/json_search.ml
Outdated
| (* We don't want to include the [sub] field of occurrence tables. We use | ||
| a "polymorphic record" to avoid defining a type, but still get named | ||
| fields! *) |
There was a problem hiding this comment.
This is original but I find it confusing and heavy in syntax. What about defining a record with just that instead ?
This record could even replace the item type in Table as the sub field is never used outside of this module.
Here's an other idea: Julow@9cafc01
There was a problem hiding this comment.
I was thinking that the sub field could be useful to some application of the occurrence table.
However, there are no such application. I removed sub from the exposed type in the last commit, and use that type instead of this weird tuple. If an application requires exposing the sub field, we'll do it at this moment.
panglesd
force-pushed
the
occurrences-in-index
branch
from
6d8cc9a
to
447e6ac
Compare
Signed-off-by: Paul-Elliot <[email protected]>
This adds the occurrence count to each element of the json index Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
Co-authored-by: Guillaume "Liam" Petiot <[email protected]>
Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
occurrences-in-index
branch
from
447e6ac
to
d4c8046
Compare
Signed-off-by: Paul-Elliot <[email protected]>
Since #972 there is a
compile-indexcommand which outputs a json index containing all searchable entries. The intended purpose of this json index is to pass it to a search engine.Since #976 there is also a
count-occurrencescommand which creates a table containing the number of occurrences for each identifier.This PR makes the
compile-indexbe able to use the information fromcount-occurrence. It adds a--occurrencesargument to get the path to the table.The first commit isolate the occurrence code in its own library.
The second commit implements the
--occurrencesargument of ``compile-index`.