fix(specs): use periods in description fields consistently - #6789
Open
kai687 wants to merge 3 commits into
Open
Conversation
Contributor
鉁旓笍 Code generated!
馃搳 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
eric-zaharia
approved these changes
Jul 29, 2026
eric-zaharia
left a comment
Contributor
There was a problem hiding this comment.
This is great, thank you!
Fluf22
force-pushed
the
fix/description-periods
branch
from
August 10, 2026 08:38
7624112 to
b74e0a2
Compare
xroche
reviewed
Aug 10, 2026
Contributor
There was a problem hiding this comment.
Posted on the wrong PR by mistake, sorry for the noise. The review belongs on #6790 and is now there.
On this PR: the punctuation pass looks right, and the one non-punctuation edit is correct. partialUpdateObject with createIfNoExists: true does add the record, so "this action adds the record to the index" is accurate. No period landed mid-sentence, which was the real risk in a | block scalar where Markdown joins consecutive lines.
Optional, all pre-existing and inside blocks this PR already edits:
- Four sentences still have no period:
attributesToHighlightandattributesToRetrieve("Attribute names are case-sensitive"),minProximity("by equally scoring matches that are farther apart"), and two lines inresponseFields. - Two grammar errors survive on lines this PR rewrote: "considered an exact matches" in
alternativesAsExact, and "a more broader search" insimilarQuery. Batch.ymlleaves- \delete`. Delete an index.with a period where its siblings use- `key`: description`.
kai687
force-pushed
the
fix/description-periods
branch
from
August 12, 2026 14:48
b74e0a2 to
46fcf20
Compare
ClaraMuller
approved these changes
Aug 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
馃Л What and Why
Many sentences in
descriptionfields didn't end in periods, although more sentences followed. I believe this was introduced in PR #5125 by accident.馃師 JIRA Ticket: N/A
Changes included:
specs/common/schemas/Batch.yml馃И Test
N/A