Module naming consistency

nemoNoboru / monkey_type

microgem to add a micro type system to ruby

https://rubygems.org/gems/monkey_type

MIT License

2 stars 1 forks source link

Module naming consistency #2

Closed rwhitworth closed 8 years ago

rwhitworth commented 8 years ago

Within the README.md the module is named monkey_type, MonkeyType, and monkeyType. I found this confusing when trying to install the gem and use the module in irb. Is there a single name that can be used consistently to reduce friction for a new user of the module?

Also, congrats on the GSoC work!

nemoNoboru commented 8 years ago

will work on it. and thanks. Man, the gsoc is just awesome, I guess I was just lucky. If you are a student consider making a proposal. :)

nemoNoboru commented 8 years ago

I've done some research and by this naming recommendations the names are ok. gem name monkey_type -> require statement require 'monkey_type' -> main module MonkeyType By the way, after the merge of your pull request the usage of the gem is pretty clear now (= less friction). thanks again!