search

rojopolis / spellcheck-github-actions

Spell check action
MIT License
138 stars 38 forks source link

Investigate possible issue with error count PySpelling #15

Closed jonasbn closed 4 years ago

jonasbn commented 4 years ago

Hi @edumco

Thanks for the elaborate feedback. I have compiled your comments to this list:

Originally posted by @jonasbn in https://github.com/rojopolis/spellcheck-github-actions/pull/12#issuecomment-636716234

facelessuser commented 4 years ago

Pyspelling doesn't output error count: https://github.com/facelessuser/pyspelling/blob/master/pyspelling/__main__.py#L75.

That is just the exit code, which is simply 1 if there was a failure and 0 if there was no failure. It's just a boolean pass or fail currently. Failure for spelling, failure to read file, doesn't matter, the exit code is 1.

facelessuser commented 4 years ago

Source is of mistaken count is here, and we see it is in fact just referencing the exit code, not a real count: https://github.com/rojopolis/spellcheck-github-actions/blob/master/entrypoint.sh#L38.

I think people assume the (1) means number of files, when it doesn't. I would just remove the error code as the message itself indicates pass or fail.

jonasbn commented 4 years ago

Hi @facelessuser

I see the reason for the misunderstanding and the error code was mostly included for myself when I restructured the entry point.

They do not have significant value since they can be obtained by querying the shell, since they are still emitted, I agree that they can go