You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@solr.apache.org by "cdrini (via GitHub)" <gi...@apache.org> on 2023/12/18 21:22:53 UTC

[PR] Make parameter descriptions consistent in faceting.adoc [solr]

cdrini opened a new pull request, #2162:
URL: https://github.com/apache/solr/pull/2162

# Description

The parameters descriptions in the faceting docs begin inconsistently. Some re-state the parameter names, some start with "This parameters...", etc.

# Solution

Make them begin consistently and concisely by starting directly with the description of what it does.

# Tests

Did not run tests.

# Checklist

Please review the following and check all that apply:

- [x] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- NA: I have created a Jira issue and added the issue ID to my pull request title.
- [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [x] I have developed this patch against the `main` branch.
- NA I have run `./gradlew check`.
- NA I have added tests for my changes.
- NA I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)

--
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-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org

Re: [PR] Make parameter descriptions consistent in faceting.adoc [solr]

Posted by "cpoerschke (via GitHub)" <gi...@apache.org>.

cpoerschke commented on code in PR #2162:
URL: https://github.com/apache/solr/pull/2162#discussion_r1439672251


##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -113,7 +113,7 @@ This does not limit the query in any way, only the facets that would be returned
 |Optional |Default: none
 |===
 +
-If `facet.contains` is used, the `facet.contains.ignoreCase` parameter causes case to be ignored when matching the given substring against candidate facet terms.
+Causes case to be ignored when matching the `facet.contains` substring against candidate facet terms.

Review Comment:
   nit/subjective
   ```suggestion
   If set to `true`, causes case to be ignored when matching the `facet.contains` substring against candidate facet terms.
   ```



##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -149,7 +147,7 @@ Note that the default logic is changed when <<Limiting Facet with Certain Terms>
 |Optional |Default: `100`
 |===
 +
-This parameter specifies the maximum number of constraint counts (essentially, the number of facets for a field that are returned) that should be returned for the facet fields.
+The number of facet counts returned.
 A negative value means that Solr will return unlimited number of constraint counts.

Review Comment:
   ```suggestion
   A negative value means that Solr will return all counts.
   ```



##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -168,7 +166,7 @@ The `facet.offset` parameter indicates an offset into the list of constraints to
 |Optional |Default: `0`
 |===
 +
-The `facet.mincount` parameter specifies the minimum counts required for a facet field to be included in the response.
+The minimum count required for a facet field to be included in the response.
 If a field's counts are below the minimum, the field's facet is not returned.

Review Comment:
   Wondering about "field" versus "term" wording here. WDYT?
   
   ```suggestion
   The minimum count required for a facet field term to be included in the response.
   If a term's count is below the minimum, the term is not returned.
   ```



##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -187,7 +185,7 @@ If set to `true`, this parameter indicates that, in addition to the Term-based c
 |Optional |Default: `fc`
 |===
 +
-The `facet.method` parameter selects the type of algorithm or method Solr should use when faceting a field.
+Selects the type of algorithm or method Solr should use when faceting a field.

Review Comment:
   ```suggestion
   Selects the type of algorithm or method to use when faceting a field.
   ```



##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -131,12 +131,10 @@ If you want to only return facet buckets for the terms that match a regular expr
 |Optional |Default: none
 |===
 +
-This parameter determines the ordering of the facet field constraints.
+The ordering of the facet field constraints. There are two options:

Review Comment:
   ```suggestion
   The ordering of the facet field terms. There are two options:
   ```



-- 
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-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org

Re: [PR] Make parameter descriptions consistent in faceting.adoc [solr]

Posted by "epugh (via GitHub)" <gi...@apache.org>.

epugh commented on PR #2162:
URL: https://github.com/apache/solr/pull/2162#issuecomment-1983459204

   hey @cdrini  do you want to take another spin though this PR and finalize some of the changes?   Then I'd love to merge this!


-- 
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-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org

Re: [PR] Make parameter descriptions consistent in faceting.adoc [solr]

Posted by "janhoy (via GitHub)" <gi...@apache.org>.

janhoy commented on code in PR #2162:
URL: https://github.com/apache/solr/pull/2162#discussion_r1431049930


##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -396,7 +392,7 @@ To ensure you avoid double-counting, do not choose both `lower` and `upper`, do
 |Optional |Default: none
 |===
 +
-The `facet.range.other` parameter specifies that in addition to the counts for each range constraint between `facet.range.start` and `facet.range.end`, counts should also be computed for these options:
+In addition to the counts for each range constraint between `facet.range.start` and `facet.range.end`, counts should also be computed for these options:

Review Comment:
   ```suggestion
   In addition to the counts for each range constraint between `facet.range.start` and `facet.range.end`, counts will also be computed for these options:
   ```



##########
solr/solr-ref-guide/modules/query-guide/pages/faceting.adoc:
##########
@@ -149,7 +147,7 @@ Note that the default logic is changed when <<Limiting Facet with Certain Terms>
 |Optional |Default: `100`
 |===
 +
-This parameter specifies the maximum number of constraint counts (essentially, the number of facets for a field that are returned) that should be returned for the facet fields.
+The number of facets for a field that are returned.

Review Comment:
   "facets" is a bit overloaded here, perhaps use "count" or "size"?



-- 
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-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org

Re: [PR] Make parameter descriptions consistent in faceting.adoc [solr]

Posted by "epugh (via GitHub)" <gi...@apache.org>.

epugh merged PR #2162:
URL: https://github.com/apache/solr/pull/2162


-- 
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-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org