ctargett opened a new pull request #208: URL: https://github.com/apache/solr/pull/208
https://issues.apache.org/jira/browse/SOLR-14444 # Description As part of the Ref Guide reorg, I introduced a new structure for parameters to add a short table at the start of all parameter descriptions indicating if it was required/optional and the default value (if any). I'd only done a few pages at the time of the merge of the main set of work. An example of what this looks like is in the wiki: https://cwiki.apache.org/confluence/display/SOLR/Ref+Guide+Re-Org+2021?preview=/181309814/181309851/params-in-html.png. The intention is to make this information consistent for all params and clear for users. This next series of commits updates all params to this style, using information already in the description - if the description did not already mention a default, it likely now says "none". In some cases I looked in the code for a default value, but have not in any way attempted an audit that all information is correct. If the description was already wrong or misleading, then the new table is likely also wrong or misleading. Description texts have also been edited to remove repetition regarding required/optional status and default values, except in cases where the default is dependent on other factors and that's critical for the reader to understand. Some descriptions have also been edited slightly for clarity or typos, etc. (I literally can't touch anything without editing 3 other things...). This is only a first batch so I don't drop a massive update again, although this one's still pretty big. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
