solr icon indicating copy to clipboard operation
solr copied to clipboard

Make parameter descriptions consistent in faceting.adoc

Open cdrini opened this issue 1 year ago • 1 comments

Description

The parameters descriptions in the faceting docs begin inconsistently. Some re-state the parameter names, some start with "This parameter...", 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 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 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

cdrini avatar Dec 18 '23 21:12 cdrini

This PR had no visible activity in the past 60 days, labeling it as stale. Any new activity will remove the stale label. To attract more reviewers, please tag someone or notify the [email protected] mailing list. Thank you for your contribution!

github-actions[bot] avatar Mar 07 '24 00:03 github-actions[bot]

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!

epugh avatar Mar 07 '24 13:03 epugh

Ah apologies for the delay! Will update this week :+1:

cdrini avatar Mar 08 '24 04:03 cdrini

Thanks for the review @cpoerschke ! Ok @epugh , this should be ready to go now!

cdrini avatar Mar 08 '24 04:03 cdrini