Skip to content

fix(specs): use periods in description fields consistently - #6789

Open
kai687 wants to merge 3 commits into
mainfrom
fix/description-periods
Open

fix(specs): use periods in description fields consistently#6789
kai687 wants to merge 3 commits into
mainfrom
fix/description-periods

Conversation

@kai687

@kai687 kai687 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

馃Л What and Why

Many sentences in description fields 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:

  • Make sure every sentence ends in a period
  • Use periods in list items consistently
  • Fix typo in specs/common/schemas/Batch.yml

馃И Test

N/A

@algolia-api-clients-automation-bot

algolia-api-clients-automation-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

鉁旓笍 Code generated!

Name Link
馃獡 Triggered by 6482db9c0b3d557d99f46add192fa817cd101d6b
馃崈 Generated commit 6c152b893dbc20d0abcac16783576c5610831910
馃尣 Generated branch generated/fix/description-periods
馃搳 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 2312
php 2262
go 1823
python 1458
csharp 1417
ruby 1290
java 1100
swift 982
scala 659

@kai687
kai687 marked this pull request as ready for review July 28, 2026 13:47
@kai687
kai687 requested review from a team as code owners July 28, 2026 13:47
@kai687
kai687 requested review from Fluf22 and eric-zaharia July 28, 2026 13:47

@eric-zaharia eric-zaharia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you!

@Fluf22
Fluf22 force-pushed the fix/description-periods branch from 7624112 to b74e0a2 Compare August 10, 2026 08:38

@xroche xroche left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: attributesToHighlight and attributesToRetrieve ("Attribute names are case-sensitive"), minProximity ("by equally scoring matches that are farther apart"), and two lines in responseFields.
  • Two grammar errors survive on lines this PR rewrote: "considered an exact matches" in alternativesAsExact, and "a more broader search" in similarQuery.
  • Batch.yml leaves - \delete`. Delete an index.with a period where its siblings use- `key`: description`.

@kai687
kai687 force-pushed the fix/description-periods branch from b74e0a2 to 46fcf20 Compare August 12, 2026 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants