Skip to content

Conversation

@jsoref
Copy link
Contributor

@jsoref jsoref commented Dec 12, 2024

Related Issues

Why is this change being made?

The misspellings have been reported at https://github.com/jsoref/sfs-client/actions/runs/12292227471#summary-34302447496

What is being changed?

This PR corrects misspellings identified by the check-spelling action (which is an evolution of the script I used ages ago when I first made a PR here...).

How was the change tested?

The action reports that the changes in this PR would make it happy:

https://github.com/jsoref/sfs-client/actions/runs/12292227565#summary-34302447544

Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@jsoref jsoref requested a review from a team as a code owner December 12, 2024 08:17
@arthuraraujo-msft
Copy link
Contributor

Hey @jsoref, thanks for the contribution.
Could you please first open a task with more context?

Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@jsoref
Copy link
Contributor Author

jsoref commented Dec 12, 2024

I don't think I have time before my next 🛫 to figure out how to make the linter happy. Personally, I hate linters that don't offer a patch output (since they've already done the work, they might as well show their work to save people like me the effort of setting up the tools). If I can figure out how to make the tool do what I want, I might file an issue + PR for that too. But, I don't expect to have much time for that anytime soon. This run of PRs was done while waiting for ✈️s and my vacation is just about over...

@arthuraraujo-msft arthuraraujo-msft changed the title Spelling Fixing spelling issues within the codebase Dec 12, 2024
@arthuraraujo-msft
Copy link
Contributor

I don't think I have time before my next 🛫 to figure out how to make the linter happy. Personally, I hate linters that don't offer a patch output (since they've already done the work, they might as well show their work to save people like me the effort of setting up the tools). If I can figure out how to make the tool do what I want, I might file an issue + PR for that too. But, I don't expect to have much time for that anytime soon. This run of PRs was done while waiting for ✈️s and my vacation is just about over...

The formatter check is complaining that two files are not properly formatted.

The following files have incorrect formatting:

client/include/sfsclient/ClientConfig.h
client/tests/unit/AppContentTests.cpp

Do run them through clang-format.
When the project is setup via the setup script, clang-format runs as a pre-commit hook.

@jsoref
Copy link
Contributor Author

jsoref commented Dec 12, 2024

The readme has instructions for Windows and Linux. I'm on macOS and the Linux instructions are debian specific and don't detect macOS/not Debian

@arthuraraujo-msft
Copy link
Contributor

The readme has instructions for Windows and Linux. I'm on macOS and the Linux instructions are debian specific and don't detect macOS/not Debian

Sorry, I don't have access to macOS to add instructions for it.
If you have python installed, you could try to run clang format manually.

pip install clang-format to install it
python -c 'import sysconfig; import os; print(sysconfig.get_path("scripts",f"{os.name}_user"))' to find where it's installed
Then you can call <path>/clang-format.exe -i <file> to format the given file

Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@arthuraraujo-msft arthuraraujo-msft merged commit e59c0a9 into microsoft:main Dec 13, 2024
4 checks passed
@arthuraraujo-msft
Copy link
Contributor

Thanks for the contribution, @jsoref!

@jsoref jsoref deleted the spelling branch December 13, 2024 19:19
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.

Typos and accessibility no-nos

2 participants