Uploaded image for project: 'Hibernate Search'
  1. HSEARCH-2833

Avoid confusing variable uses (bad naming, no declaration) in the documentation

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.8.0.CR1
    • Component/s: documentation
    • Labels:
      None

      Description

      For instance there: https://docs.jboss.org/hibernate/search/5.7/reference/en-US/html_single/#__a_id_elasticsearch_query_sorting_a_sorting
      We use a variable named "s" for the session, without even declaring the variable, which makes it very hard for an inexperienced user to guess what "s" is.

        Attachments

          Activity

            People

            • Assignee:
              yrodiere Yoann Rodière
              Reporter:
              yrodiere Yoann Rodière
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: