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

Add codespell: config, github workflow + make it fix some typos #1430

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

yarikoptic
Copy link

@yarikoptic yarikoptic commented Feb 16, 2024

Description

I am on the quest to make the world the typo free place ;)

Workflow would just detect typos, not fix them

Checklist:

  • I have previewed changes locally or with CircleCI (runs when PR is created)
  • I have completed any content reviews, such as getting input from relevant working groups. If no, please note this and wait to post the PR to the #website channel until the content has been settled. -- i do not think it is applicable
  • When you are ready for a technical review/merge, post the for the link for the PR in the US-RSE Slack (#website) to ask for reviewers.

@yarikoptic
Copy link
Author

image

@mrmundt
Copy link
Contributor

mrmundt commented Feb 19, 2024

@yarikoptic - We do have spell-checking enabled already (see https://github.com/USRSE/usrse.github.io/blob/main/.github/workflows/linting.yaml#L17). Why should we switch to this one?

@yarikoptic
Copy link
Author

oh right ! and that is the one which uses codespell dictionary. It is strange then (worth investigation by someone interested) why codespell found a good number of typos for me? Should I just remove codespell config/action and keep PR only with typo fixes?

if someone approves CI run, we might see/compare both

@crd477
Copy link
Contributor

crd477 commented Feb 21, 2024

It is strange then (worth investigation by someone interested) why codespell found a good number of typos for me?

Could it be because the files input is (mis-)specified as a space-separated list instead of comma-separated?

    - name: Check Spelling
      uses: crate-ci/typos@master # we should really incorporate all new changes
      with:
        files: ./_posts ./pages ./README.md
        config: ./.github/workflows/typo_config.toml

@yarikoptic
Copy link
Author

dunno -- not familiar with typos although did see it used... or may be it should be a list here?

@crd477
Copy link
Contributor

crd477 commented Feb 22, 2024

It's not the spaces. I checked the workflow logs and even tested it out in my own container, and it runs as specified despite not finding the actual typos. Weird. I'd like to keep digging a bit more.

@@ -30,7 +30,7 @@ place **Friday, March 11th at 11AM Pacific/ 2PM Eastern / 7PM GMT**

### Abstract

The role of a Research Software Engineer (RSE) is to transform research concepts and methods into practical computing workflows, blending established and innovative software techniques that incorporate technical sustainability and excellence. But to tread this path successfully it takes allies, collaborators, and process repeatability to make things happen. So how does an RSE build up this kind of ecosystem of success? This talk details how you can develop a diverse pool of resources and how sometimes reaching outside of the task you’ve been given can result in the breakthrough you need.
Copy link
Contributor

Choose a reason for hiding this comment

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

"tread" seems correct to me here, not "thread".

Copy link
Author

Choose a reason for hiding this comment

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

indeed... dang rare word. thanks! fixed (ignored/redone fixing)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
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.

None yet

4 participants