You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "ASF subversion and git services (JIRA)" <ji...@apache.org> on 2017/12/12 00:42:00 UTC

[jira] [Commented] (SOLR-11575) Cleanup Java Snippets in "Using SolrJ" ref-guide page

    [ https://issues.apache.org/jira/browse/SOLR-11575?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16286867#comment-16286867 ] 

ASF subversion and git services commented on SOLR-11575:
--------------------------------------------------------

Commit 5b2e25f301156fbe5b40e2abb670b985f74456de in lucene-solr's branch refs/heads/master from Chris Hostetter
[ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=5b2e25f ]

SOLR-11575: Improve ref-guide solrj snippets via mock 'print()' method


> Cleanup Java Snippets in "Using SolrJ" ref-guide page
> -----------------------------------------------------
>
>                 Key: SOLR-11575
>                 URL: https://issues.apache.org/jira/browse/SOLR-11575
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>    Affects Versions: master (8.0)
>            Reporter: Jason Gerlowski
>            Priority: Trivial
>         Attachments: SOLR-11575.patch, SOLR-11575.patch
>
>
> Hoss pointed out on SOLR-11032 that some of the Java snippets don't do a great job of looking like
> bq. "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.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org