Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-11575

Cleanup Java Snippets in "Using SolrJ" ref-guide page

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Trivial
    • Resolution: Implemented
    • 8.0
    • 7.3, 8.0
    • None
    • None

    Description

      Hoss pointed out on SOLR-11032 that some of the Java snippets don't do a great job of looking like

      "real code" a user might do something with in an app.

      Particularly, the snippets show how to obtain certain SolrJ objects, but they don't show readers what they can/should do with those objects. The snippets might be more useful to readers if they printed information returned in the SolrJ object as a result of each API call. Hoss specifically suggested setting up a print-asserter, which would appear to be a normal print-statement in the ref-guide snippet, but double as an assertion in the JUnit test where the snippet lives.

      This JIRA involves giving that a shot. It might make sense to figure this out before pulling more Java snippets into the build (as suggested in SOLR-11574). On the flip side, extracting more snippets into the build might inform a better, consistent format/pattern for the snippets. So these stories are related, but maybe not strict dependencies of one another.

      Attachments

        1. SOLR-11575.patch
          7 kB
          Jason Gerlowski
        2. SOLR-11575.patch
          7 kB
          Jason Gerlowski

        Activity

          People

            hossman Chris M. Hostetter
            gerlowskija Jason Gerlowski
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: