search

rrrene / credo-proposals

Proposals for Credo, the Elixir code analysis tool with a focus on code consistency and teaching
MIT License
9 stars 0 forks source link

Proposal: Spell checker in docs? #32

Open shmink opened 5 years ago

shmink commented 5 years ago

This would be a crazy one but it just occurred to me. I personally use a spellchecker I like on my browser(s) called Grammarly.

It would be nice if there was a spell checker for the text within the @doc tags but of course excluding code blocks.

I don't know how feasible this is. I suppose you would need to include or make requests to a dictionary of some sort. What are your thoughts folks?

whatyouhide commented 5 years ago

I think spell checkers are very subjective. For example, "Redix" is not a word in a dictionary but in the Redix documentation the term "Redix" appears everywhere. I think what would be more functional here is better editor support for spell checkers in documentation strings. That means having your text editor only run a spell checker in the documentation strings when it encounters a .ex file. That way, you can configure whatever personal spell checker you want plus it could work in other languages as well.

shmink commented 5 years ago

I don't disagree with anything there. Perhaps there could be a way to add to the dictionary if it were to be implemented into credo.

yordis commented 5 years ago

This would be a crazy one but it just occurred to me. I personally use a spellchecker I like on my browser(s) called Grammarly.

Believe me, you are not 😉

I don't think Credo (as today) could fix this without having a service like Grammarly.

What Credo could do is to open the API to allow people to inject spelling checkers (whatever that means) but that would be a rabbit hole for sure.

Since you are not the only crazy one @shmink I am trying to see if I can hook up some GitHub hooks for these type of things rather than being on Credo.

rrrene commented 5 years ago

@yordis @shmink Credo Plugins will enable you to provide funtionality like this.

The Plugin System is in active development on this branch: https://github.com/rrrene/credo/tree/add-plugins