Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fixed typo in scripts/cspell/project-words.txt #753

Merged
merged 2 commits into from
Oct 11, 2024

Conversation

priyanshsao
Copy link
Contributor

Which problem is this PR solving?

Description of the changes

  • Removed unnecessary words from the dictionary and updated their occurrences in the relevant files.

How was this change tested?

  • make spellcheck

Checklist

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for romantic-neumann-1959d7 ready!

Name Link
🔨 Latest commit b209af2
🔍 Latest deploy log https://app.netlify.com/sites/romantic-neumann-1959d7/deploys/67095bad3553a2000833cf18
😎 Deploy Preview https://deploy-preview-753--romantic-neumann-1959d7.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

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

Thanks

@yurishkuro yurishkuro enabled auto-merge (squash) October 10, 2024 14:20
ingesters
ingester's
Copy link
Member

Choose a reason for hiding this comment

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

Please revert order change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When the change is reverted and the make spellcheck command is run, the output displays a sorting error -

cat scripts/cspell/project-names.txt | grep -v '^#' | grep -v '^\s*$' | tr ' ' '\n' > scripts/cspell/project-names-parsed.txt
cd scripts/cspell && ./spellcheck.sh
sort: project-words.txt:40: disorder: ingesters
project-words.txt is not sorted.
make: *** [Makefile:60: spellcheck] Error 1

@yurishkuro
Copy link
Member

It is failing now

@priyanshsao
Copy link
Contributor Author

So, should I consider reverting the change?

@yurishkuro
Copy link
Member

You need to make sure the linter passes. You can test it locally.

@priyanshsao
Copy link
Contributor Author

The reason ingester's appears before ingesters in a sorted list is that it is treated as "ingester" followed by an apostrophe, whereas ingesters is treated as "ingester" followed by the letter s. This means that the apostrophe has a higher priority in the sort order than the letter s. If you were to place ingester's after ingesters, it would trigger a sorting error because the list is expected to follow alphabetical order, taking into account all characters, including punctuation. This is why it fails to pass the linter.

@yurishkuro
Copy link
Member

I don't understand the motivation for your explanation - what are you trying to prove? Before your change the linter was not complaining, now it does complain.

@priyanshsao
Copy link
Contributor Author

priyanshsao commented Oct 11, 2024

To check i ran the 'make checkspell' in main branch and it showed the same error , i understand what you are saying but in main branch where nothing is changed still it is showing the error.

Signed-off-by: Yuri Shkuro <[email protected]>
@yurishkuro yurishkuro merged commit f334558 into jaegertracing:main Oct 11, 2024
10 checks passed
@priyanshsao
Copy link
Contributor Author

@yurishkuro, I apologize for the confusion earlier. There was an issue with my terminal, which caused the error to appear.

@priyanshsao priyanshsao deleted the issue-#701 branch October 12, 2024 17:33
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.

2 participants