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

Inline annotations in files with spell-check issues #1

Closed
spier opened this issue Jan 9, 2021 · 5 comments
Closed

Inline annotations in files with spell-check issues #1

spier opened this issue Jan 9, 2021 · 5 comments

Comments

@spier
Copy link

spier commented Jan 9, 2021

hi @reitermarkus and thanks for this nice Action.

I am new to aspell but I am using a couple of other GitHub Actions already in https://github.com/InnerSourceCommons/InnerSourcePatterns.

I already got your Action to run in this experiment, so far so good :)
InnerSourceCommons/InnerSourcePatterns#272

Right now the output of aspell is only available in the logs.

I am wondering if it would be possible to create inline annotations in files that have spell-check issues?
That way it would be easier for PR authors to spot where the issue is and fix it.

Any pointers would be appreciated.

@reitermarkus
Copy link
Owner

The annotations should already show up in the Files tab in pull requests, don't they?

@spier
Copy link
Author

spier commented Jan 9, 2021

You are right, it already works.
Not sure where I was looking the last time.

Now I see inline annotations like this:
Screen Shot 2021-01-09 at 17 03 21

Will close the issue.

@spier spier closed this as completed Jan 9, 2021
@spier
Copy link
Author

spier commented Jan 9, 2021

One other related question if I may:
In the meantime I found this other action rojopolis/spellcheck-github-actions which is a wrapper around PySpelling, which in turn uses aspell as I understand.

Was just curious if you have seen that other action and what you think about the pros/cons of the PySpelling wrapper when compared to using aspell directly? Not saying that one is better than the other, just interested in learning more about the use cases for both of them as this is my first time trying to automate any sort of spell-checking.

@reitermarkus
Copy link
Owner

No, I haven't seen PySpelling or the other action before, so I can't comment on which use cases they might be used for.

@spier
Copy link
Author

spier commented Jan 9, 2021

Ok. No problem and thanks for the quick responses.
I already learned a bit more about spell checking today at least :)

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

No branches or pull requests

2 participants