Jason Gerlowski created SOLR-11575:
--------------------------------------
Summary: 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
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: [email protected]
For additional commands, e-mail: [email protected]
