Methods not showing up in search results #330
Comments
|
Modules are ranked above methods in search results. This is because there are "escape hatches" to search for methods, but no equivalent escape hatch for modules. Try searching for "#render", ".render", or "render(":
I've submitted #331 to add a tip about this. |
jonathanhefner
added a commit
to jonathanhefner/sdoc
that referenced
this issue
Oct 25, 2023
Prior to this commit, modules would rank above methods in search results. This ensured, for example, that `ActionController::Rendering` would rank above `ActionController::Rendering#render` when searching for "ActionController::Rendering". However, `ActionController::Rendering` would also rank above `ActionController::Rendering#render` when searching for just "render". Though the method _does_ rank first when searching for "#render" or ".render", such queries may not be intuitive. Based on the idea that users will be searching for _either_ a module _or_ a method, this commit removes the higher-ranked module-specific ngrams from method entries in the search index. For example, the method entry for `ActionController::Rendering#render` will no longer include the ":Ac", " Ac", ":Re", and " Re" ngrams (though it will still include the "Act", "Ren", etc ngrams). Furthermore, this commit changes the tie-breaker bonuses to be reduced in proportion to just the method name for methods or the module name for modules, whereas before it was reduced in proportion to the fully qualified name for both methods and modules. The end result is that `ActionController::Rendering` still ranks above `ActionController::Rendering#render` when searching for "ActionController::Rendering", but `ActionController::Rendering#render` now ranks above `ActionController::Rendering` when searching for just "render". Fixes rails#330.
|
After some more thought, I think I have found a good compromise: #343. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When I search for
renderI'm not seeing any render methods in the results:The text was updated successfully, but these errors were encountered: