[hibernate-issues] [JIRA] (HSEARCH-4863) Minor improvements to the documentation of highlighting

Yoann Rodière ( https://hibernate.atlassian.net/secure/ViewProfile.jspa?accountId=557058%... ) *created* an issue Hibernate Search ( https://hibernate.atlassian.net/browse/HSEARCH?atlOrigin=eyJpIjoiZGNmNGM3... ) / Improvement ( https://hibernate.atlassian.net/browse/HSEARCH-4863?atlOrigin=eyJpIjoiZGN... ) HSEARCH-4863 ( https://hibernate.atlassian.net/browse/HSEARCH-4863?atlOrigin=eyJpIjoiZGN... ) Minor improvements to the documentation of highlighting ( https://hibernate.atlassian.net/browse/HSEARCH-4863?atlOrigin=eyJpIjoiZGN... ) Issue Type: Improvement Assignee: Marko Bekhta ( https://hibernate.atlassian.net/secure/ViewProfile.jspa?accountId=557058%... ) Components: documentation Created: 02/Jun/2023 02:32 AM Fix Versions: 6.2-backlog Priority: Major Reporter: Yoann Rodière ( https://hibernate.atlassian.net/secure/ViewProfile.jspa?accountId=557058%... ) * In https://docs.jboss.org/hibernate/search/6.2/reference/en-US/html_single/#... , the class being mapped in the first snippet ( BookWithHighlights ) does not match the class targeted by the search in the following snippets ( Book ) * In Example 360. Using a highlight projection , we really should add a block showing the possible content of the returned hits, because it’s not that obvious. * We should probably do the same as #2 in a few other (strategic) places, e.g. https://docs.jboss.org/hibernate/search/6.2/reference/en-US/html_single/#... (maybe others, but I’m not sure; let’s not repeat ourselves too much) ( https://hibernate.atlassian.net/browse/HSEARCH-4863#add-comment?atlOrigin... ) Add Comment ( https://hibernate.atlassian.net/browse/HSEARCH-4863#add-comment?atlOrigin... ) Get Jira notifications on your phone! Download the Jira Cloud app for Android ( https://play.google.com/store/apps/details?id=com.atlassian.android.jira.... ) or iOS ( https://itunes.apple.com/app/apple-store/id1006972087?pt=696495&ct=Em... ) This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100225- sha1:e03cc87 )