search

bernedom / SI

A header only C++ library that provides type safety and user defined literals for physical units
https://si.dominikberner.ch/doc/
MIT License
486 stars 40 forks source link

Fix spelling #109

Closed melg8 closed 2 years ago

melg8 commented 2 years ago

What this pull request is all about

Hi @bernedom! You and your collaborators created great library! But i think we can improve it.

I think SI library is all about precision. So it would be nice not just have statically checked units, but also to have right spelling in library. Even such small things can make a difference.

So this pull request fix spelling errors in:

I've split all fixes into different commits - so if you don't like some of them i can remove them in modular fashion. If you prefer pull request with single commit you can squash them, or i can do it myself.

Display of continuous benchmark badge in readme might be broken by this pull request because link contained misspell in it. So new URL without misspell need to be generated.

Improving CI

Your project already have nice CI setup. But it can be also improved.

Shameless plug: I actively develop cit - CI template for c++ projects. (Would appreciate if you star it, or give some feedback in issues!) Although it is more about creation of new c++ projects, it can still be used to check already existing projects, for example: I've used it to find all this misspells by cloning your project as sub project in "sources" directory. Main script which found all misspells is located here. You can check dictionary which i created for your project here - it has all words that were marked as unknown, but i think are okay for your project. So even not using cit directly - you can use it as example to integrate checkers:

Current merge request fixes spelling issues, but it think if you integrate such tools into your CI pipeline that would protect your project from regression.

Collaboration

All changes i made are MIT licensed. If you don't want you don't need to mention me as contributor in each of changed files, once again, i would appreciate cit stars and feedback/ideas.

I'm open to collaboration and job offers. Really passionate about making great CI setups for c++ code. You can contact me public.melg8@gmail.com

Thank you for your time!

bernedom commented 2 years ago

Hey, @melg8 thank you for your contribution. Your project cit looks very promising, although I did not yet have the time to dive in deeper. I will definitively see if I can integrate some parts like cspell into the CI pipeline.