obs-studio icon indicating copy to clipboard operation
obs-studio copied to clipboard

Fix spelling errors

Open umlaeute opened this issue 1 year ago • 5 comments

  • Closes: https://github.com/obsproject/obs-studio/issues/11160

Description

Fixes a number of spelling mistakes in (log-)messages, documentation and comments.

Motivation and Context

Proper English makes log-messages, documentation and code more readable.

How Has This Been Tested?

still builds

Types of changes

  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Documentation (a change to documentation pages)

Checklist:

  • [ ] My code has been run through clang-format.
  • [x] I have read the contributing document.
  • [x] My code is not on the master branch.
  • [x] The code has been tested.
  • [x] All commit messages are properly formatted and commits squashed where appropriate.
  • [x] I have included updates to all appropriate documentation.

umlaeute avatar Aug 21 '24 10:08 umlaeute

Just speaking personally, I would prefer not to bother with spellchecking comments or vendored dependencies. User facing messages and log output seems fine, assuming those log messages are our code and not from a dep.

Fenrirthviti avatar Aug 21 '24 15:08 Fenrirthviti

I was under the impression, that libcaption is unmaintained upstream and therefore is now practically maintained by the OBS project. Hence I felt safe to change it. In and case, it is a separate commit, so it can be left out.

Re: commit-guidelines: I followed them to the best of my knowledge, could you elaborate on what is wrong?

Re: spell checking comments: I understand that you don't want to do the work yourself, but I fail to see why it shouldn't be approved if somebody did the work for you...

umlaeute avatar Aug 21 '24 16:08 umlaeute

It isn't about doing the work, it's about touching 55 files that otherwise have no meaningful changes, impacting git history.

However, this is just my opinion.

Fenrirthviti avatar Aug 21 '24 17:08 Fenrirthviti

i force-pushed with

  • removed fixes for the UI (as it is managed by Crowdin)
  • removed fixes for libnsgif (as the current spelling is a valid variant)

i kept the changes to the vendored simde and rnnoise libraries, as they have been fixed upstream a while ago (several years in the case of rnnoise) but have yet not been synced (as of today).

umlaeute avatar Sep 16 '24 06:09 umlaeute

i force-pushed again with

  • changes to rnnoise removed
  • changes to simde removed

umlaeute avatar Sep 16 '24 16:09 umlaeute

It isn't about doing the work, it's about touching 55 files that otherwise have no meaningful changes, impacting git history.

However, this is just my opinion.

Easy enough to workaround using the .git-blame-ignore-revs^1 file. Here's the doc^2 for anyone unfamiliar.

luzpaz avatar Jan 19 '25 08:01 luzpaz