Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

fix(specs): remove periods on summaries #3013

Merged
merged 2 commits into from
Apr 17, 2024
Merged

fix(specs): remove periods on summaries #3013

merged 2 commits into from
Apr 17, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Apr 17, 2024

🧭 What and Why

Add a new ESLint rule to remove trailing . on summary fields.
This will make the docs look a tiny bit better, since the summary entries are used as headers.

Changes included:

  • Add new rule no-final-dot
  • Modify existing rule end-with-dot
  • Remove final . from summaries

🧪 Test

I added a unit test for the rule.

@kai687 kai687 marked this pull request as ready for review April 17, 2024 03:54
@kai687 kai687 requested a review from a team as a code owner April 17, 2024 03:54
@algolia-bot
Copy link
Collaborator

algolia-bot commented Apr 17, 2024 •
edited
Loading

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 17, 2024 •
edited
Loading

🚀 Deployed on https://661f8022af8e4ae4ad581de0--api-clients-automation.netlify.app

@github-actions github-actions bot temporarily deployed to pull request April 17, 2024 04:06 Inactive
shortcuts
shortcuts approved these changes Apr 17, 2024
View reviewed changes
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

nothing to add I like the idea!

Fluf22
Fluf22 approved these changes Apr 17, 2024
View reviewed changes
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

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

Perfect 🆗

@github-actions github-actions bot temporarily deployed to pull request April 17, 2024 07:54 Inactive
@shortcuts shortcuts merged commit f9877a8 into main Apr 17, 2024
25 checks passed
@shortcuts shortcuts deleted the feat/eslint branch April 17, 2024 07:56
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@shortcuts shortcuts shortcuts approved these changes

@Fluf22 Fluf22 Fluf22 approved these changes

@morganleroi morganleroi Awaiting requested review from morganleroi morganleroi is a code owner automatically assigned from algolia/api-clients-automation

@millotp millotp Awaiting requested review from millotp millotp is a code owner automatically assigned from algolia/api-clients-automation

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kai687 @algolia-bot @Fluf22 @shortcuts